From 6d154a892ccb1991a8c6c914e6b2fab7333270fc Mon Sep 17 00:00:00 2001 From: Dave Hagen <3d.hagen@gmail.com> Date: Wed, 17 Jun 2026 21:58:15 -0700 Subject: [PATCH 1/4] Update API reference links to match new TypeDoc PascalCase filenames Also fix navbar/footer API Reference links to use trailing slash, and fix two pre-existing link bugs (double slash, duplicate path segment). Co-Authored-By: Claude Sonnet 4.6 --- website/docs/core/trex_format.md | 4 +- website/docs/core/trex_multiple_dialogs.md | 4 +- website/docs/core/trex_tableau_viz.md | 2 +- website/docs/debug/trex_error_handling.md | 2 +- website/docs/trex_release-notes.md | 90 ++++++++++++++-------- website/docs/trex_tableau_viz_ref_v1.md | 2 +- website/docs/trex_tableau_viz_ref_v2.md | 2 +- website/docusaurus.config.js | 4 +- 8 files changed, 68 insertions(+), 42 deletions(-) diff --git a/website/docs/core/trex_format.md b/website/docs/core/trex_format.md index 6622cdd7..cdaa8932 100644 --- a/website/docs/core/trex_format.md +++ b/website/docs/core/trex_format.md @@ -9,7 +9,7 @@ To help your dashboard extension match the look and feel of the dashboard in whi ## Apply Tableau classes to HTML elements -Starting with the Dashboard Extensions API v1.7 library, and supported with Tableau 2021.4 or later, you can apply workbook formatting styles by specifying the class on the HTML elements in your extension. The specific Tableau classes to use are defined in the [`ClassNameKey`](pathname:///api/enums/tableau.classnamekey.html) enum. +Starting with the Dashboard Extensions API v1.7 library, and supported with Tableau 2021.4 or later, you can apply workbook formatting styles by specifying the class on the HTML elements in your extension. The specific Tableau classes to use are defined in the [`ClassNameKey`](pathname:///api/enums/ClassNameKey.html) enum. | HTML style (string literal) | ClassNameKey enum| | :------------ | :---------- | @@ -91,4 +91,4 @@ For more information about using event listeners, see [Events and Event Handling * To see a working sample dashboard extension that uses workbook formatting, see the JavaScript [Formatting](https://github.com/tableau/extensions-api/tree/main/Samples/Dashboard/Formatting) sample in the Samples folder, or the TypeScript [Formatting](https://github.com/tableau/extensions-api/tree/main/Samples-Typescript/Dashboard/Formatting) sample in the Samples-Typescript folder. -* For information about accessing the formatting styles in a workbook, see [workbookFormatting](pathname:///api/interfaces/environment.html#workbookformatting) in the API reference documentation. +* For information about accessing the formatting styles in a workbook, see [workbookFormatting](pathname:///api/interfaces/Environment.html#workbookformatting) in the API reference documentation. diff --git a/website/docs/core/trex_multiple_dialogs.md b/website/docs/core/trex_multiple_dialogs.md index 4b320607..888dfd7b 100644 --- a/website/docs/core/trex_multiple_dialogs.md +++ b/website/docs/core/trex_multiple_dialogs.md @@ -32,11 +32,11 @@ You can't display these other dialog boxes or windows directly when the user sel * Determine where to place the controls to display the popup windows. For example, in your main extension window, or in the configuration dialog. Add the controls (buttons, toolbars) to your extension HTML code to create the additional dialog boxes or popup windows. -* Use the [`displayDialogAsync()`](pathname:///api/interfaces/ui.html#displaydialogasync) method to display the popup window. You would probably call the `displayDialogAsync()` method from a wrapper that gets triggered when the user clicks a button or icon in a toolbar. In your extension JavaScript or TypeScript code, define your popup windows: the `popupURL`, the dialog style, and dimensions, and any initial payload you want to send to the popup window. And provide any necessary code for handling the payload that's returned from the popup window. +* Use the [`displayDialogAsync()`](pathname:///api/interfaces/UI.html#displaydialogasync) method to display the popup window. You would probably call the `displayDialogAsync()` method from a wrapper that gets triggered when the user clicks a button or icon in a toolbar. In your extension JavaScript or TypeScript code, define your popup windows: the `popupURL`, the dialog style, and dimensions, and any initial payload you want to send to the popup window. And provide any necessary code for handling the payload that's returned from the popup window. Like the configuration popup, the URL of the additional popup windows must belong to the same domain as the parent extension. The relative paths must resolve to the directory, or a child directory, of the extension. Root-relative paths aren’t allowed. For example, `./config.html` or `config.html` are allowed, but not the root-relative path `/config.html`. -* In your HTML and JavaScript code for your popup window, call the [`initializeDialogAsync()`](pathname:///api/interfaces/extensions.html#initializedialogasync) method and add code to process the initial payload, if you’re using it. In addition to whatever features you want the popup window to do, add a control (for example, a Save button) that you can attach to the `closeDialog()` method. The `closeDialog()` method safely closes the dialog box and returns the payload to the calling extension (or window). +* In your HTML and JavaScript code for your popup window, call the [`initializeDialogAsync()`](pathname:///api/interfaces/Extensions.html#initializedialogasync) method and add code to process the initial payload, if you’re using it. In addition to whatever features you want the popup window to do, add a control (for example, a Save button) that you can attach to the `closeDialog()` method. The `closeDialog()` method safely closes the dialog box and returns the payload to the calling extension (or window). * If you have more than one popup window, you must create a system for tracking the state of each popup window. For example, calling `displayDialogAsync()` method for an already-open dialog box throws an error. And if you only want one popup window open at a time, and you don't want them to be modal, you must track which popup is open and which popup is queued up. A simple Map or Flag variable can accomplish this tracking. diff --git a/website/docs/core/trex_tableau_viz.md b/website/docs/core/trex_tableau_viz.md index 2622ba46..7bf43727 100644 --- a/website/docs/core/trex_tableau_viz.md +++ b/website/docs/core/trex_tableau_viz.md @@ -196,7 +196,7 @@ Now that you have seen the basic steps for adding a Tableau Viz to a dashboard e * For information about the Tableau Viz version 1 and version 2 `inputSpec` and all the options for specifying the visualization, see [Tableau Viz Reference](../trex_tableau_viz_ref.md). -* Review the [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/extensions#createvizimageasync) method for information about the API. +* Review the [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/Extensions#createvizimageasync) method for information about the API. * Check out the [Tableau Viz Sample - VizImage](https://github.com/tableau/extensions-api/tree/main/Samples/Dashboard/VizImage) and see how it works. Examine the source code to find out ways you can incorporate Tableau Viz into your own dashboard extensions. diff --git a/website/docs/debug/trex_error_handling.md b/website/docs/debug/trex_error_handling.md index 9921269b..21ee0d4b 100644 --- a/website/docs/debug/trex_error_handling.md +++ b/website/docs/debug/trex_error_handling.md @@ -7,7 +7,7 @@ Errors that are returned from the Extensions API are custom Tableau error object ## Using Extensions API error codes -The Extensions API wraps the standard error object with an `errorCode` property. You can use this error code for debugging or troubleshooting your extension. Any time you encounter an error when you are running your extension, you can look at this `errorCode` to determine the cause. See [Error Codes](pathname:///api/enums/tableau.errorcodes.html). +The Extensions API wraps the standard error object with an `errorCode` property. You can use this error code for debugging or troubleshooting your extension. Any time you encounter an error when you are running your extension, you can look at this `errorCode` to determine the cause. See [Error Codes](pathname:///api/enums/ErrorCodes.html). As you create your extension, you want to be sure to catch potential error conditions. For example, you should validate user input and make use of `try` ... `catch` statements. The Extensions API makes use of JavaScript promises. You can use the `.catch` method to field the errors that could be returned in the promise and any subsequent `.then` methods. diff --git a/website/docs/trex_release-notes.md b/website/docs/trex_release-notes.md index 6a3004f6..4c30b4f5 100644 --- a/website/docs/trex_release-notes.md +++ b/website/docs/trex_release-notes.md @@ -8,6 +8,35 @@ description: What's new for each release of the Tableau Extensions API --- +### Tableau Extensions API version 1.17.0 + +*June 2026* + +* Tableau Dashboard Extensions API library: `tableau.extensions.1.17.0.js`
(download or clone the Extensions API repository on [GitHub](https://github.com/tableau/extensions-api)).
+ +* Certain features in this release are only available in Tableau Cloud, Tableau Server, and Tableau Desktop 2026.2 or later. Download [Tableau Desktop](https://www.tableau.com/support/releases). + +What's new in this release: + +* Added `DataRole` and `SemanticRole` properties for fields returned in results from the `Worksheet.getVisualSpecificationAsync` method. + +* Added `WorkbookLocale` to `Environment`. + +* Added support for exporting extensions on Tableau Cloud and Server platforms. + + * Added the `reportExtensionRenderComplete` method to `Extensions`, which can be called by an extension to indicate that it is ready for exporting. + + * Added the `ExportedMediaType` enum property to `Environment`, which indicates the media type an +extension is being exported as. + + * Added the `isExporting` property to `Environment` which indicates if the extension is currently +being exported. + +--- + +## Previous Releases + + ### Tableau Extensions API version 1.16.0 *February 2026* @@ -22,14 +51,11 @@ What's new in this release: * Added support for multiple dialogs. In addition to the configuration popup window, you can add other dialog boxes or popup windows that can interact with the extension. See [Add Multiple Dialog Boxes](./core/trex_multiple_dialogs.md). -* Added the [sendDialogMessageAsync](pathname:///api/interfaces/ui.html#senddialogmessageasync) and the [sendDialogMessageToParentAsync](pathname:///api/interfaces/ui.html#senddialogmessagetoparentasync) methods to the UI namespace. Use the `sendDialogMessageAsync` method to send messages between any two dialog boxes, or between any dialog box and the extension. Use the `sendDialogMessageToParentAsync` method to send a message from the dialog box to the extension or to the dialog box (the parent) that opened it. See [Send messages between popup dialog boxes and the extension](core/trex_multiple_dialogs#send-messages-between-popup-dialog-boxes-and-the-extension). - +* Added the [sendDialogMessageAsync](pathname:///api/interfaces/UI.html#senddialogmessageasync) and the [sendDialogMessageToParentAsync](pathname:///api/interfaces/UI.html#senddialogmessagetoparentasync) methods to the UI namespace. Use the `sendDialogMessageAsync` method to send messages between any two dialog boxes, or between any dialog box and the extension. Use the `sendDialogMessageToParentAsync` method to send a message from the dialog box to the extension or to the dialog box (the parent) that opened it. See [Send messages between popup dialog boxes and the extension](core/trex_multiple_dialogs#send-messages-between-popup-dialog-boxes-and-the-extension). --- -## Previous Releases - ### Tableau Extensions API version 1.15.0 *September 2025* @@ -66,7 +92,7 @@ For more information, see [Debug Extensions in Tableau Desktop](./debug/trex_deb What's new in this release: -* Added `hasAlias` and `aliasValue` attributes to [DataValue](pathname:///api/interfaces/datavalue.html). +* Added `hasAlias` and `aliasValue` attributes to [DataValue](pathname:///api/interfaces/DataValue.html). * Fixed a bug that caused an error when calling the `getAllDataSourcesAsync` method on a workbook with no worksheets. @@ -86,11 +112,11 @@ What's new in this release: What's new in this release: -* (Viz Extensions) Added the [`WorksheetFormattingChanged`](pathname:///api/interfaces/worksheetformattingchangedevent.html) event to the [`worksheet`](pathname:///api/interfaces/worksheet.html). Use this event to take action whenever the worksheet's formatting changes. Note that this event is also raised when the workbook's formatting changes. +* (Viz Extensions) Added the [`WorksheetFormattingChanged`](pathname:///api/interfaces/WorksheetFormattingChangedEvent.html) event to the [`worksheet`](pathname:///api/interfaces/Worksheet.html). Use this event to take action whenever the worksheet's formatting changes. Note that this event is also raised when the workbook's formatting changes. -* Added [`backgroundColor`](pathname:///api/interfaces/worksheet.html#backgroundcolor) and [`formatting`](pathname:///api/interfaces/worksheet.html#formatting) properties to the [`worksheet`](pathname:///api/interfaces/worksheet.html). These properties return the background color and formatting of the worksheet (that is, the formatting sheets that contain the CSS properties). +* Added [`backgroundColor`](pathname:///api/interfaces/Worksheet.html#backgroundcolor) and [`formatting`](pathname:///api/interfaces/Worksheet.html#formatting) properties to the [`worksheet`](pathname:///api/interfaces/Worksheet.html). These properties return the background color and formatting of the worksheet (that is, the formatting sheets that contain the CSS properties). -* Added `applyWorksheetFormatting` as a property of [`GetSummaryDataOptions`](pathname:///api/interfaces/getsummarydataoptions.html#applyworksheetformatting) and [`GetUnderlyingDataOptions`](pathname:///api/interfaces/getunderlyingdataoptions.html#applyworksheetformatting). This property specifies whether to apply worksheet-level formatting to numbers and dates. You can use this option with the get summary and get underlying data APIs (such as, [`getSummaryDataReaderAsync`](pathname:///api/interfaces/worksheet.html#getsummarydatareaderasync), [`getUnderlyingTableDataReaderAsync`](pathname:///api/interfaces/worksheet.html#getunderlyingtabledatareaderasync)). +* Added `applyWorksheetFormatting` as a property of [`GetSummaryDataOptions`](pathname:///api/interfaces/GetSummaryDataOptions.html#applyworksheetformatting) and [`GetUnderlyingDataOptions`](pathname:///api/interfaces/GetUnderlyingDataOptions.html#applyworksheetformatting). This property specifies whether to apply worksheet-level formatting to numbers and dates. You can use this option with the get summary and get underlying data APIs (such as, [`getSummaryDataReaderAsync`](pathname:///api/interfaces/Worksheet.html#getsummarydatareaderasync), [`getUnderlyingTableDataReaderAsync`](pathname:///api/interfaces/Worksheet.html#getunderlyingtabledatareaderasync)). @@ -109,12 +135,12 @@ What's new in this release: * Support for Viz Extensions. Viz Extensions is a new feature that allows developers to create new viz types that Tableau users can access through the worksheet Marks card. See [Getting Started with Viz Extensions](./vizext/trex_viz_getstarted.md). -* Updated the [`Worksheet.selectTuplesAsync`](pathname:///api/interfaces/worksheet.html#selecttuplesasync) method to now support multiple tuple values. This means you can enable multi-selection scenarios. For example, the viz extension can support mark selection for rectangular, lasso, or other shaped multi-mark selections. You can use this method for marks or zones that represent multiple values. +* Updated the [`Worksheet.selectTuplesAsync`](pathname:///api/interfaces/Worksheet.html#selecttuplesasync) method to now support multiple tuple values. This means you can enable multi-selection scenarios. For example, the viz extension can support mark selection for rectangular, lasso, or other shaped multi-mark selections. You can use this method for marks or zones that represent multiple values. * Added [Keyboard Accessible](https://www.w3.org/TR/UNDERSTANDING-WCAG20/keyboard-operation.html) navigation methods. - * You can use the [`Worksheet.getTooltipTextAsync`](pathname:///api/interfaces/worksheet.html#gettooltiptextasync) method to grab the data of the navigated tuple to read out to a screen reader. + * You can use the [`Worksheet.getTooltipTextAsync`](pathname:///api/interfaces/Worksheet.html#gettooltiptextasync) method to grab the data of the navigated tuple to read out to a screen reader. - * Use the [`Worksheet.leaveMarkNavigationAsync`](pathname:///api/interfaces/worksheet.html#leavemarknavigationasync) method to escape focus back over to Tableau when you're done with mark navigation. + * Use the [`Worksheet.leaveMarkNavigationAsync`](pathname:///api/interfaces/Worksheet.html#leavemarknavigationasync) method to escape focus back over to Tableau when you're done with mark navigation. * (Viz Extensions) You can now specify the encoding icons used on the Marks card and provide for localization. You set these options in the `.trex` manifest file. See [Add encoding to the viz manifest](./vizext/trex_viz_manifest.md#add-encoding-in-the-viz-manifest). @@ -130,9 +156,9 @@ What's new in this release: * Added support for interactivity in viz extensions. You can add actions and tooltips based on marks selection or hover over interactions. This release includes two new `worksheet` methods. - * Use the [`Worksheet.selectTuplesAsync`](pathname:///api/interfaces/worksheet.html#selecttuplesasync) method to display the Tableau tooltip for the selected marks, or to take some other action based upon the marks selection. + * Use the [`Worksheet.selectTuplesAsync`](pathname:///api/interfaces/Worksheet.html#selecttuplesasync) method to display the Tableau tooltip for the selected marks, or to take some other action based upon the marks selection. - * Use the [`Worksheet.hoverTupleAsync`](pathname:///api/interfaces/worksheet.html#hovertupleasync) method to display a tooltip for the marks currently hovered over. + * Use the [`Worksheet.hoverTupleAsync`](pathname:///api/interfaces/Worksheet.html#hovertupleasync) method to display a tooltip for the marks currently hovered over. For an example of how you can use these methods, see the [Sankey](https://github.com/tableau/extensions-api/tree/main/Samples/Viz/Sankey?=target="_blank") viz extension sample. @@ -194,15 +220,15 @@ About this release: ---- -* Adds support for a [DataTableReader](pathname:///api/interfaces/datatablereader.html) to support pagination. Created with [Worksheet.getSummaryDataReaderAsync](pathname:///api/interfaces/worksheet.html#getsummarydatareaderasync), -[Worksheet.getUnderlyingTableDataReaderAsync](pathname:///api/interfaces/worksheet.html#getunderlyingtabledatareaderasync), and [DataSource.getLogicalTableDataReaderAsync](pathname:///api/interfaces/datasource.html#getlogicaltabledatareaderasync). +* Adds support for a [DataTableReader](pathname:///api/interfaces/DataTableReader.html) to support pagination. Created with [Worksheet.getSummaryDataReaderAsync](pathname:///api/interfaces/Worksheet.html#getsummarydatareaderasync), +[Worksheet.getUnderlyingTableDataReaderAsync](pathname:///api/interfaces/Worksheet.html#getunderlyingtabledatareaderasync), and [DataSource.getLogicalTableDataReaderAsync](pathname:///api/interfaces/DataSource.html#getlogicaltabledatareaderasync). For more information, see [Get Data from the View](./core/trex_getdata.md). -* Deprecated `getSummaryDataAsync`. Use [Worksheet.getSummaryDataReaderAsync](pathname:///api/interfaces/worksheet.html#getsummarydatareaderasync) instead. +* Deprecated `getSummaryDataAsync`. Use [Worksheet.getSummaryDataReaderAsync](pathname:///api/interfaces/Worksheet.html#getsummarydatareaderasync) instead. -* The [UI.displayDialogAsync](pathname:///api/interfaces/ui.html#displaydialogasync) now supports different dialog styles (window, modal or modeless dialog boxes). +* The [UI.displayDialogAsync](pathname:///api/interfaces/UI.html#displaydialogasync) now supports different dialog styles (window, modal or modeless dialog boxes). -* Adds support for annotating marks with [Worksheet.annotateMarkAsync](pathname:///api/interfaces/worksheet.html#annotatemarkasync), [Worksheet.getAnnotationsAsync](pathname:///api/interfaces/worksheet.html#getannotationsasync), and [Worksheet.removeAnnotationAsync](pathname:///api/interfaces/worksheet.html#removeannotationasync). See the code sample, [Annotation](https://github.com/tableau/extensions-api/tree/dev/Samples/Dashboard/Annotation) (on GitHub). +* Adds support for annotating marks with [Worksheet.annotateMarkAsync](pathname:///api/interfaces/Worksheet.html#annotatemarkasync), [Worksheet.getAnnotationsAsync](pathname:///api/interfaces/Worksheet.html#getannotationsasync), and [Worksheet.removeAnnotationAsync](pathname:///api/interfaces/Worksheet.html#removeannotationasync). See the code sample, [Annotation](https://github.com/tableau/extensions-api/tree/dev/Samples/Dashboard/Annotation) (on GitHub). --- @@ -218,11 +244,11 @@ For more information, see [Get Data from the View](./core/trex_getdata.md). About this release: -* Added support for [`Filter.getAppliedWorksheets()`](pathname:///api//interfaces/filter.html#getappliedworksheetsasync) and [`Filter.setAppliedWorksheets()`](pathname:///api/interfaces/filter.html#setappliedworksheetsasync). +* Added support for [`Filter.getAppliedWorksheets()`](pathname:///api/interfaces/Filter.html#getappliedworksheetsasync) and [`Filter.setAppliedWorksheets()`](pathname:///api/interfaces/Filter.html#setappliedworksheetsasync). -* Added support for [`Dashboard.getFiltersAsync()`](pathname:///api/interfaces/dashboard.html#getfiltersasync) and [`Dashboard.applyFilterAsync()`](pathname:///api/interfaces/dashboard.html#applyfilterasync). +* Added support for [`Dashboard.getFiltersAsync()`](pathname:///api/interfaces/Dashboard.html#getfiltersasync) and [`Dashboard.applyFilterAsync()`](pathname:///api/interfaces/Dashboard.html#applyfilterasync). -* Added support for [`Worksheet.applyRelativeDateFilterAsync()`](pathname:///api/interfaces/worksheet.html#applyrelativedatefilterasync). +* Added support for [`Worksheet.applyRelativeDateFilterAsync()`](pathname:///api/interfaces/Worksheet.html#applyrelativedatefilterasync). * Starting with this release, you can now load Benton Sans fonts and Tableau fonts by default during extension initialization. You can set the Tableau and Benton Sans fonts in the style portion of your extension. To see how you can use the fonts in a dashboard extension, see the [Formatting](https://github.com/tableau/extensions-api/tree/master/Samples/Dashboard/Formatting?=target="_blank") sample. @@ -314,11 +340,11 @@ For more information, see [Tableau Viz Reference](./trex_tableau_viz_ref.md). About this release: -* Added a new method, [`moveAndResizeDashboardObjectsAsync`](pathname:///api/interfaces/dashboard.html#dashboard.html#moveandresizedashboardobjectsasync). you can use to set the position and size of one or more floating dashboard objects. This can be useful for creating overlays, annotations, popups, or dynamic layouts. +* Added a new method, [`moveAndResizeDashboardObjectsAsync`](pathname:///api/interfaces/Dashboard.html#moveandresizedashboardobjectsasync). you can use to set the position and size of one or more floating dashboard objects. This can be useful for creating overlays, annotations, popups, or dynamic layouts. -* Added a new method that can replay an animation in a dashboard. You can control the replay speed (`tableau.ReplaySpeedType.Slow`, `tableau.ReplaySpeedType.Normal`, or `tableau.ReplaySpeedType.Fast`). For more information, see the [`replayAnimationAsync`](pathname:///api/interfaces/dashboard.html#replayanimationasync) method. +* Added a new method that can replay an animation in a dashboard. You can control the replay speed (`tableau.ReplaySpeedType.Slow`, `tableau.ReplaySpeedType.Normal`, or `tableau.ReplaySpeedType.Fast`). For more information, see the [`replayAnimationAsync`](pathname:///api/interfaces/Dashboard.html#replayanimationasync) method. -* Dashboard extensions can now use workbook formatting by setting the appropriate class on the HTML elements. The specific Tableau classes to use are defined in the [`ClassNameKey`](pathname:///api/enums/tableau.classnamekey.html) enum. To apply the formatting in the body of your HTML page, use the string literal `tableau-*` for the enum. For example, to apply the worksheet title formatting you set the `class` for the HTML element in your extension (`div`, `h2`, etc.) to `"tableau-worksheet-title"`. +* Dashboard extensions can now use workbook formatting by setting the appropriate class on the HTML elements. The specific Tableau classes to use are defined in the [`ClassNameKey`](pathname:///api/enums/ClassNameKey.html) enum. To apply the formatting in the body of your HTML page, use the string literal `tableau-*` for the enum. For example, to apply the worksheet title formatting you set the `class` for the HTML element in your extension (`div`, `h2`, etc.) to `"tableau-worksheet-title"`. ```html

Subheader, using tableau-worksheet-title class

@@ -339,13 +365,13 @@ About this release: * You can now set an event listener on changes to the dashboard layout and to the dashboard formatting. The new event types are `DashboardLayoutChanged` and `WorkbookFormattingChanged`. - The `DashboardLayoutChanged` event is triggered whenever a dashboard object is added, removed, repositioned or resized, or whenever the floating state, visibility, object name, or dashboard size changes. See the [DashboardLayoutChanged](pathname:///api/interfaces/dashboard.html#dashboardlayoutchanged). event. + The `DashboardLayoutChanged` event is triggered whenever a dashboard object is added, removed, repositioned or resized, or whenever the floating state, visibility, object name, or dashboard size changes. See the [DashboardLayoutChanged](pathname:///api/interfaces/Dashboard.html#dashboardlayoutchanged). event. - The `WorkbookFormattingChanged` event is triggered whenever the workbook text formatting is changed in Tableau authoring mode. This includes changes in the font, the font size, whether it is bold, italic, or underlined, and the color. For more information about workbook formatting, see [workbookFormatting](pathname:///api/interfaces/environment.html#workbookformatting). + The `WorkbookFormattingChanged` event is triggered whenever the workbook text formatting is changed in Tableau authoring mode. This includes changes in the font, the font size, whether it is bold, italic, or underlined, and the color. For more information about workbook formatting, see [workbookFormatting](pathname:///api/interfaces/Environment.html#workbookformatting). * Transparency - Tableau now supports dashboard extension transparency for Sandboxed extensions. To take advantage of extension transparency, set your background style to a transparent or partially transparent color. -* Added a new method (`setClickThroughAsync`) that allows clicks to pass through the dashboard extension window. You can use this method in conjunction with transparency. See the [setClickThroughAsync](pathname:///api/interfaces/extensions.html#setclickthroughasync) method. +* Added a new method (`setClickThroughAsync`) that allows clicks to pass through the dashboard extension window. You can use this method in conjunction with transparency. See the [setClickThroughAsync](pathname:///api/interfaces/Extensions.html#setclickthroughasync) method. @@ -367,7 +393,7 @@ About this release: ![Tableau Viz SVG image](./assets/vizapi_demo3.svg) -Starting with version 1.6 of the Dashboard Extensions API library and Tableau 2021.3, you can now add Tableau visualizations to your dashboard extensions. Tableau Viz takes a declarative description of your visualization and renders it as an SVG image that you can embed in your extension. Version 1.6 of the Dashboard Extensions library adds the [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/extensions.html#createvizimageasync) method, which takes a JavaScript object describing the image as an input.
+Starting with version 1.6 of the Dashboard Extensions API library and Tableau 2021.3, you can now add Tableau visualizations to your dashboard extensions. Tableau Viz takes a declarative description of your visualization and renders it as an SVG image that you can embed in your extension. Version 1.6 of the Dashboard Extensions library adds the [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/Extensions.html#createvizimageasync) method, which takes a JavaScript object describing the image as an input.
For more information about using Tableau Viz, see:
- [Add Tableau Viz to Your Dashboard Extensions](./core/trex_tableau_viz.md) - [Tableau Viz Reference](./trex_tableau_viz_ref.md) @@ -394,7 +420,7 @@ About this release: * The `selectMarksByValueAsync` method now supports combined selection criteria types (bug fixed). -* The following are all improvements to the [`getSummaryDataAsync`](pathname:///api/interfaces/worksheet.html#getsummarydataasync) method: +* The following are all improvements to the [`getSummaryDataAsync`](pathname:///api/interfaces/Worksheet.html#getsummarydataasync) method: * `getSummaryDataAsync` now has a smaller and faster payload. @@ -448,7 +474,7 @@ About this release: * `DataValue` now has a `nativeValue` member. This member represents the raw native value as a JavaScript type, which is one of string, number, boolean, or Date object. Note that special values are returned as null. The `nativeValue` helps simplify error checking as all values will either be their native type value or null. The `nativeValue` exists for *ALL* `DataValue` objects, including those returned from parameters, filters, selections, and underlying or summary data. Dates values are in UTC. -* Added documentation for the [clearSelectedMarksAsync()](pathname:///api/interfaces/worksheet.html#clearselectedmarksasync) method, which clears the selected marks in the current worksheet. +* Added documentation for the [clearSelectedMarksAsync()](pathname:///api/interfaces/Worksheet.html#clearselectedmarksasync) method, which clears the selected marks in the current worksheet. Bugs fixed in this release: @@ -526,7 +552,7 @@ Bugs fixed in this release: * The `environment.apiVersion` property now correctly reports the version of the Extensions API library that the extension is using. -* The documentation for the selectMarksByValueAsync method has been corrected. If you are calling the method, be sure to specify the complete namespace for the `SelectionUpdateType` enum that is passed to the method as the `updateType` parameter. For example, use `tableau.SelectionUpdateType.Replace`, to replace the currently selected marks with the values you specify in the method call. +* The documentation for the selectMarksByValueAsync method has been corrected. If you are calling the method, be sure to specify the complete namespace for the `SelectionUpdateType` enum that is passed to the method as the `updateType` parameter. For example, use `tableau.SelectionUpdateType.Replace`, to replace the currently selected marks with the values you specify in the method call. ---- @@ -884,7 +910,7 @@ Error: internal-error: permission-denied: Missing required permission to run get Errors that are returned from the Extensions API are custom Tableau Error objects that extends the standard JavaScript error object. -The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes](pathname:///api/enums/tableau.errorcodes.html). +The Extensions API wraps the standard error object with an `errorCode` property. Any time you encounter an error when you are developing your extension, you can look at this `errorCode` to determine the cause. See [Error Codes](pathname:///api/enums/ErrorCodes.html). For an example of how to handle error conditions, see the [UINamespace](https://github.com/tableau/extensions-api/tree/main/Samples/Dashboard/UINamespace?=target="_blank") sample. The sample shows how you could handle the error condition that occurs if a user dismisses a modal dialog box (`DialogClosedByUser`). The following snippet illustrates this pattern: diff --git a/website/docs/trex_tableau_viz_ref_v1.md b/website/docs/trex_tableau_viz_ref_v1.md index bd5cb139..9aaebee7 100644 --- a/website/docs/trex_tableau_viz_ref_v1.md +++ b/website/docs/trex_tableau_viz_ref_v1.md @@ -20,7 +20,7 @@ createVizImageAsync( inputSpec: *object* ): Promise ``` This method takes a single argument, the `inputSpec`, a JavaScript object, and returns the SVG description of that image. To call this method, you first initialize the Dashboard Extensions API (`tableau.extensions.initialize()`). You then create the `inputSpec` object that defines your graphic. -For more information about the method, see [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/extensions#createvizimageasync) in the Dashboard Extensions API reference. +For more information about the method, see [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/Extensions#createvizimageasync) in the Dashboard Extensions API reference. ## Specification for `inputSpec` (version 1) object diff --git a/website/docs/trex_tableau_viz_ref_v2.md b/website/docs/trex_tableau_viz_ref_v2.md index d9137aa1..9847a5ef 100644 --- a/website/docs/trex_tableau_viz_ref_v2.md +++ b/website/docs/trex_tableau_viz_ref_v2.md @@ -23,7 +23,7 @@ createVizImageAsync( inputSpec: *object* ): Promise ``` This method takes a single argument, the `inputSpec`, a JavaScript object, and returns the SVG description of that image. To call this method, you first initialize the Dashboard Extensions API (`tableau.extensions.initialize()`). You then create the `inputSpec` object that defines your graphic. -For more information about the method, see [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/extensions.html#createvizimageasync) in the Dashboard Extensions API reference. +For more information about the method, see [`tableau.extensions.createVizImageAsync`](pathname:///api/interfaces/Extensions.html#createvizimageasync) in the Dashboard Extensions API reference. --- diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index a4a7da1f..17819b6e 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -87,7 +87,7 @@ const getConfig = async () => { label: 'Guides', }, { - to: 'pathname:///api', + to: 'pathname:///api/', label: 'API Reference', }, { @@ -146,7 +146,7 @@ const getConfig = async () => { }, { label: 'API Reference', - to: 'pathname:///api', + to: 'pathname:///api/', }, { label: 'UX Design Guide', From a7df06934c430ba73282864be8f3d7f3d656da04 Mon Sep 17 00:00:00 2001 From: Dave Hagen <3d.hagen@gmail.com> Date: Wed, 17 Jun 2026 21:59:12 -0700 Subject: [PATCH 2/4] Replace API reference with TypeDoc v1.17.0 generated output New TypeDoc version uses PascalCase filenames, drops the tableau. namespace prefix from enum filenames, adds types/ and variables/ sections, and updates asset structure. Co-Authored-By: Claude Sonnet 4.6 --- website/static/api/assets/css/main.css | 2321 ----------------- website/static/api/assets/custom.css | 47 + website/static/api/assets/favicon.ico | Bin 0 -> 1150 bytes website/static/api/assets/hierarchy.js | 1 + website/static/api/assets/highlight.css | 85 + website/static/api/assets/icons.js | 18 + website/static/api/assets/icons.svg | 1 + website/static/api/assets/images/icons.png | Bin 9615 -> 0 bytes website/static/api/assets/images/icons@2x.png | Bin 28144 -> 0 bytes website/static/api/assets/images/widgets.png | Bin 480 -> 0 bytes .../static/api/assets/images/widgets@2x.png | Bin 855 -> 0 bytes website/static/api/assets/js/main.js | 1 - website/static/api/assets/js/search.js | 3 - website/static/api/assets/main.js | 60 + website/static/api/assets/navigation.js | 1 + website/static/api/assets/search.js | 1 + website/static/api/assets/style.css | 1633 ++++++++++++ .../static/api/enums/AnalyticsObjectType.html | 28 + website/static/api/enums/AnnotationType.html | 28 + website/static/api/enums/ClassNameKey.html | 33 + website/static/api/enums/ColumnType.html | 28 + .../api/enums/DashboardLayoutChange.html | 46 + .../static/api/enums/DashboardObjectType.html | 37 + .../enums/DashboardObjectVisibilityType.html | 31 + website/static/api/enums/DataFormatType.html | 36 + website/static/api/enums/DataType.html | 34 + website/static/api/enums/DateRangeType.html | 32 + website/static/api/enums/DialogStyle.html | 29 + website/static/api/enums/EncodingType.html | 41 + website/static/api/enums/ErrorCodes.html | 52 + .../static/api/enums/ExtensionContext.html | 31 + website/static/api/enums/ExtensionMode.html | 28 + .../api/enums/FieldAggregationType.html | 66 + website/static/api/enums/FieldRoleType.html | 29 + .../static/api/enums/FilterDomainType.html | 31 + .../static/api/enums/FilterNullOption.html | 30 + website/static/api/enums/FilterType.html | 30 + .../static/api/enums/FilterUpdateType.html | 30 + .../HierarchicalLevelSelectionState.html | 31 + .../api/enums/IncludeDataValuesOption.html | 37 + website/static/api/enums/MarkType.html | 39 + .../api/enums/NegativeNumberFormat.html | 31 + .../static/api/enums/NumberFormatUnits.html | 30 + .../static/api/enums/ParameterValueType.html | 30 + website/static/api/enums/PeriodType.html | 37 + .../static/api/enums/QuickTableCalcType.html | 37 + website/static/api/enums/ReplaySpeedType.html | 33 + website/static/api/enums/SelectOptions.html | 30 + .../static/api/enums/SelectionUpdateType.html | 29 + website/static/api/enums/SheetType.html | 29 + website/static/api/enums/SortDirection.html | 27 + .../static/api/enums/TableauEventType.html | 46 + .../static/api/enums/TrendLineModelType.html | 29 + .../api/enums/VizImageEncodingType.html | 29 + .../static/api/enums/VizImagePaletteType.html | 29 + .../VizImageSizeSettingAlignmentType.html | 30 + .../api/enums/VizImageSizeSettingType.html | 29 + .../api/enums/VizImageSortDirectionType.html | 29 + .../static/api/enums/sharederrorcodes.html | 585 +---- .../enums/tableau.analyticsobjecttype.html | 228 -- .../api/enums/tableau.annotationtype.html | 228 -- .../api/enums/tableau.classnamekey.html | 298 --- .../static/api/enums/tableau.columntype.html | 228 -- .../enums/tableau.dashboardlayoutchange.html | 383 --- .../enums/tableau.dashboardobjecttype.html | 347 --- ...tableau.dashboardobjectvisibilitytype.html | 236 -- .../static/api/enums/tableau.datatype.html | 305 --- .../api/enums/tableau.daterangetype.html | 277 -- .../static/api/enums/tableau.dialogstyle.html | 235 -- .../api/enums/tableau.encodingtype.html | 410 --- .../static/api/enums/tableau.errorcodes.html | 440 ---- .../api/enums/tableau.extensioncontext.html | 263 -- .../api/enums/tableau.extensionmode.html | 221 -- .../enums/tableau.fieldaggregationtype.html | 753 ------ .../api/enums/tableau.fieldroletype.html | 235 -- .../api/enums/tableau.filterdomaintype.html | 232 -- .../api/enums/tableau.filternulloption.html | 236 -- .../static/api/enums/tableau.filtertype.html | 249 -- .../api/enums/tableau.filterupdatetype.html | 249 -- ...bleau.hierarchicallevelselectionstate.html | 254 -- .../tableau.includedatavaluesoption.html | 259 -- .../static/api/enums/tableau.marktype.html | 375 --- .../api/enums/tableau.parametervaluetype.html | 236 -- .../static/api/enums/tableau.periodtype.html | 347 --- .../api/enums/tableau.quicktablecalctype.html | 354 --- .../api/enums/tableau.replayspeedtype.html | 255 -- .../enums/tableau.selectionupdatetype.html | 235 -- .../api/enums/tableau.selectoptions.html | 231 -- .../static/api/enums/tableau.sheettype.html | 235 -- .../api/enums/tableau.sortdirection.html | 214 -- .../api/enums/tableau.tableaueventtype.html | 380 --- .../api/enums/tableau.trendlinemodeltype.html | 242 -- .../enums/tableau.vizimageencodingtype.html | 226 -- .../enums/tableau.vizimagepalettetype.html | 226 -- ...leau.vizimagesizesettingalignmenttype.html | 240 -- .../tableau.vizimagesizesettingtype.html | 226 -- .../tableau.vizimagesortdirectiontype.html | 226 -- website/static/api/globals.html | 673 ----- website/static/api/hierarchy.html | 25 + website/static/api/index.html | 539 +--- .../api/interfaces/DataFormattingOptions.html | 55 + .../api/interfaces/WorksheetFormatting.html | 28 + website/static/api/interfaces/annotation.html | 336 +-- .../api/interfaces/categoricaldomain.html | 267 +- .../api/interfaces/categoricalfilter.html | 562 +--- website/static/api/interfaces/column.html | 344 +-- .../api/interfaces/connectionsummary.html | 319 +-- website/static/api/interfaces/dashboard.html | 1076 ++------ .../api/interfaces/dashboardcontent.html | 250 +- .../dashboardlayoutchangedevent.html | 281 +- .../api/interfaces/dashboardobject.html | 467 +--- .../dashboardobjectpositionandsizeupdate.html | 336 +-- website/static/api/interfaces/datasource.html | 657 +---- .../datasourceunderlyingdataoptions.html | 352 +-- website/static/api/interfaces/datatable.html | 398 +-- .../api/interfaces/datatablereader.html | 470 +--- website/static/api/interfaces/datavalue.html | 356 +-- .../api/interfaces/dialogmessageevent.html | 304 +-- .../static/api/interfaces/dialogoptions.html | 282 +- website/static/api/interfaces/encoding.html | 323 +-- .../static/api/interfaces/environment.html | 506 +--- .../api/interfaces/eventlistenermanager.html | 399 +-- website/static/api/interfaces/extensions.html | 684 +---- website/static/api/interfaces/field.html | 577 +--- .../static/api/interfaces/fieldinstance.html | 562 +--- website/static/api/interfaces/filter.html | 449 +--- .../api/interfaces/filterchangedevent.html | 348 +-- .../static/api/interfaces/filteroptions.html | 246 +- .../api/interfaces/formattingsheet.html | 257 +- .../api/interfaces/getsummarydataoptions.html | 394 +-- .../interfaces/getunderlyingdataoptions.html | 421 +-- .../api/interfaces/hierarchicalfilter.html | 599 +---- .../hierarchicalfilterdatavalue.html | 294 +-- .../interfaces/hierarchicalleveldetail.html | 267 +- .../api/interfaces/hierarchicallevels.html | 242 +- .../static/api/interfaces/logicaltable.html | 255 +- website/static/api/interfaces/markinfo.html | 294 +-- .../api/interfaces/markscollection.html | 250 +- .../api/interfaces/marksselectedevent.html | 332 +-- .../api/interfaces/marksspecification.html | 255 +- website/static/api/interfaces/parameter.html | 575 +--- .../api/interfaces/parameterchangedevent.html | 284 +- .../parameterdomainrestriction.html | 383 +-- website/static/api/interfaces/point.html | 267 +- .../static/api/interfaces/rangedomain.html | 290 +- .../static/api/interfaces/rangefilter.html | 552 +--- .../api/interfaces/rangefilteroptions.html | 266 +- website/static/api/interfaces/rangevalue.html | 290 +- .../api/interfaces/relativedatefilter.html | 532 +--- .../interfaces/relativedatefilteroptions.html | 319 +-- .../api/interfaces/selectioncriteria.html | 269 +- website/static/api/interfaces/settings.html | 635 +---- .../api/interfaces/settingschangedevent.html | 283 +- website/static/api/interfaces/sheet.html | 538 +--- website/static/api/interfaces/size.html | 267 +- .../interfaces/summarydatachangedevent.html | 304 +-- .../static/api/interfaces/tableauerror.html | 311 +-- .../static/api/interfaces/tableauevent.html | 266 +- .../api/interfaces/tableausheetevent.html | 278 +- .../api/interfaces/tableauworksheetevent.html | 311 +-- .../static/api/interfaces/tablesummary.html | 313 +-- .../static/api/interfaces/tooltipcontext.html | 248 +- website/static/api/interfaces/ui.html | 530 +--- .../api/interfaces/visualspecification.html | 285 +- website/static/api/interfaces/workbook.html | 267 +- .../api/interfaces/workbookformatting.html | 252 +- .../workbookformattingchangedevent.html | 273 +- website/static/api/interfaces/worksheet.html | 2124 +++------------ .../api/interfaces/worksheetcontent.html | 256 +- .../worksheetformattingchangedevent.html | 329 +-- website/static/api/modules.html | 25 + website/static/api/modules/tableau.html | 407 --- .../static/api/types/CategoricalValue.html | 26 + .../types/DashboardLayoutChangeDetails.html | 26 + ...boardObjectPositionAndSizeUpdateArray.html | 26 + .../types/DashboardObjectVisibilityMap.html | 26 + website/static/api/types/DataFormat.html | 35 + .../api/types/TableauEventHandlerFn.html | 27 + .../api/types/TableauEventUnregisterFn.html | 28 + .../static/api/types/ZoneVisibilityMap.html | 26 + .../static/api/types/ZoneVisibilityType.html | 27 + .../api/variables/ZoneVisibilityType.html | 25 + 182 files changed, 7219 insertions(+), 38855 deletions(-) delete mode 100644 website/static/api/assets/css/main.css create mode 100644 website/static/api/assets/custom.css create mode 100644 website/static/api/assets/favicon.ico create mode 100644 website/static/api/assets/hierarchy.js create mode 100644 website/static/api/assets/highlight.css create mode 100644 website/static/api/assets/icons.js create mode 100644 website/static/api/assets/icons.svg delete mode 100644 website/static/api/assets/images/icons.png delete mode 100644 website/static/api/assets/images/icons@2x.png delete mode 100644 website/static/api/assets/images/widgets.png delete mode 100644 website/static/api/assets/images/widgets@2x.png delete mode 100644 website/static/api/assets/js/main.js delete mode 100644 website/static/api/assets/js/search.js create mode 100644 website/static/api/assets/main.js create mode 100644 website/static/api/assets/navigation.js create mode 100644 website/static/api/assets/search.js create mode 100644 website/static/api/assets/style.css create mode 100644 website/static/api/enums/AnalyticsObjectType.html create mode 100644 website/static/api/enums/AnnotationType.html create mode 100644 website/static/api/enums/ClassNameKey.html create mode 100644 website/static/api/enums/ColumnType.html create mode 100644 website/static/api/enums/DashboardLayoutChange.html create mode 100644 website/static/api/enums/DashboardObjectType.html create mode 100644 website/static/api/enums/DashboardObjectVisibilityType.html create mode 100644 website/static/api/enums/DataFormatType.html create mode 100644 website/static/api/enums/DataType.html create mode 100644 website/static/api/enums/DateRangeType.html create mode 100644 website/static/api/enums/DialogStyle.html create mode 100644 website/static/api/enums/EncodingType.html create mode 100644 website/static/api/enums/ErrorCodes.html create mode 100644 website/static/api/enums/ExtensionContext.html create mode 100644 website/static/api/enums/ExtensionMode.html create mode 100644 website/static/api/enums/FieldAggregationType.html create mode 100644 website/static/api/enums/FieldRoleType.html create mode 100644 website/static/api/enums/FilterDomainType.html create mode 100644 website/static/api/enums/FilterNullOption.html create mode 100644 website/static/api/enums/FilterType.html create mode 100644 website/static/api/enums/FilterUpdateType.html create mode 100644 website/static/api/enums/HierarchicalLevelSelectionState.html create mode 100644 website/static/api/enums/IncludeDataValuesOption.html create mode 100644 website/static/api/enums/MarkType.html create mode 100644 website/static/api/enums/NegativeNumberFormat.html create mode 100644 website/static/api/enums/NumberFormatUnits.html create mode 100644 website/static/api/enums/ParameterValueType.html create mode 100644 website/static/api/enums/PeriodType.html create mode 100644 website/static/api/enums/QuickTableCalcType.html create mode 100644 website/static/api/enums/ReplaySpeedType.html create mode 100644 website/static/api/enums/SelectOptions.html create mode 100644 website/static/api/enums/SelectionUpdateType.html create mode 100644 website/static/api/enums/SheetType.html create mode 100644 website/static/api/enums/SortDirection.html create mode 100644 website/static/api/enums/TableauEventType.html create mode 100644 website/static/api/enums/TrendLineModelType.html create mode 100644 website/static/api/enums/VizImageEncodingType.html create mode 100644 website/static/api/enums/VizImagePaletteType.html create mode 100644 website/static/api/enums/VizImageSizeSettingAlignmentType.html create mode 100644 website/static/api/enums/VizImageSizeSettingType.html create mode 100644 website/static/api/enums/VizImageSortDirectionType.html delete mode 100644 website/static/api/enums/tableau.analyticsobjecttype.html delete mode 100644 website/static/api/enums/tableau.annotationtype.html delete mode 100644 website/static/api/enums/tableau.classnamekey.html delete mode 100644 website/static/api/enums/tableau.columntype.html delete mode 100644 website/static/api/enums/tableau.dashboardlayoutchange.html delete mode 100644 website/static/api/enums/tableau.dashboardobjecttype.html delete mode 100644 website/static/api/enums/tableau.dashboardobjectvisibilitytype.html delete mode 100644 website/static/api/enums/tableau.datatype.html delete mode 100644 website/static/api/enums/tableau.daterangetype.html delete mode 100644 website/static/api/enums/tableau.dialogstyle.html delete mode 100644 website/static/api/enums/tableau.encodingtype.html delete mode 100644 website/static/api/enums/tableau.errorcodes.html delete mode 100644 website/static/api/enums/tableau.extensioncontext.html delete mode 100644 website/static/api/enums/tableau.extensionmode.html delete mode 100644 website/static/api/enums/tableau.fieldaggregationtype.html delete mode 100644 website/static/api/enums/tableau.fieldroletype.html delete mode 100644 website/static/api/enums/tableau.filterdomaintype.html delete mode 100644 website/static/api/enums/tableau.filternulloption.html delete mode 100644 website/static/api/enums/tableau.filtertype.html delete mode 100644 website/static/api/enums/tableau.filterupdatetype.html delete mode 100644 website/static/api/enums/tableau.hierarchicallevelselectionstate.html delete mode 100644 website/static/api/enums/tableau.includedatavaluesoption.html delete mode 100644 website/static/api/enums/tableau.marktype.html delete mode 100644 website/static/api/enums/tableau.parametervaluetype.html delete mode 100644 website/static/api/enums/tableau.periodtype.html delete mode 100644 website/static/api/enums/tableau.quicktablecalctype.html delete mode 100644 website/static/api/enums/tableau.replayspeedtype.html delete mode 100644 website/static/api/enums/tableau.selectionupdatetype.html delete mode 100644 website/static/api/enums/tableau.selectoptions.html delete mode 100644 website/static/api/enums/tableau.sheettype.html delete mode 100644 website/static/api/enums/tableau.sortdirection.html delete mode 100644 website/static/api/enums/tableau.tableaueventtype.html delete mode 100644 website/static/api/enums/tableau.trendlinemodeltype.html delete mode 100644 website/static/api/enums/tableau.vizimageencodingtype.html delete mode 100644 website/static/api/enums/tableau.vizimagepalettetype.html delete mode 100644 website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html delete mode 100644 website/static/api/enums/tableau.vizimagesizesettingtype.html delete mode 100644 website/static/api/enums/tableau.vizimagesortdirectiontype.html delete mode 100644 website/static/api/globals.html create mode 100644 website/static/api/hierarchy.html create mode 100644 website/static/api/interfaces/DataFormattingOptions.html create mode 100644 website/static/api/interfaces/WorksheetFormatting.html create mode 100644 website/static/api/modules.html delete mode 100644 website/static/api/modules/tableau.html create mode 100644 website/static/api/types/CategoricalValue.html create mode 100644 website/static/api/types/DashboardLayoutChangeDetails.html create mode 100644 website/static/api/types/DashboardObjectPositionAndSizeUpdateArray.html create mode 100644 website/static/api/types/DashboardObjectVisibilityMap.html create mode 100644 website/static/api/types/DataFormat.html create mode 100644 website/static/api/types/TableauEventHandlerFn.html create mode 100644 website/static/api/types/TableauEventUnregisterFn.html create mode 100644 website/static/api/types/ZoneVisibilityMap.html create mode 100644 website/static/api/types/ZoneVisibilityType.html create mode 100644 website/static/api/variables/ZoneVisibilityType.html diff --git a/website/static/api/assets/css/main.css b/website/static/api/assets/css/main.css deleted file mode 100644 index ed89d937..00000000 --- a/website/static/api/assets/css/main.css +++ /dev/null @@ -1,2321 +0,0 @@ -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * HTML5 display definitions - * ========================================================================== */ -/** - * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; } - -/** - * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; } - -/** - * Prevent modern browsers from displaying `audio` without controls. - * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; } - -/** - * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * Known issue: no IE 6 support. */ -[hidden] { - display: none; } - -/* ========================================================================== - * Base - * ========================================================================== */ -/** - * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * `em` units. - * 2. Prevent iOS text size adjust after orientation change, without disabling - * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; } - -/** - * Address `font-family` inconsistency between `textarea` and other form - * elements. */ -button, input, select, textarea { - font-family: sans-serif; } - -/** - * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; } - -/* ========================================================================== - * Links - * ========================================================================== */ -/** - * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; } - -a:active, a:hover { - outline: 0; } - -/** - * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * Typography - * ========================================================================== */ -/** - * Address font sizes and margins set differently in IE 6/7. - * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; } - -h2 { - font-size: 1.5em; - margin: 0.83em 0; } - -h3 { - font-size: 1.17em; - margin: 1em 0; } - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; } - -h5 { - font-size: 0.83em; - margin: 1.67em 0; } - -h6 { - font-size: 0.67em; - margin: 2.33em 0; } - -/** - * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; } - -/** - * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; } - -blockquote { - margin: 1em 40px; } - -/** - * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; } - -/** - * Address differences between Firefox and other browsers. - * Known issue: no IE 6/7 normalization. */ -hr { - box-sizing: content-box; - height: 0; } - -/** - * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; } - -/** - * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; } - -/** - * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: 'courier new', monospace; - font-size: 1em; } - -/** - * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; } - -/** - * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; } - q:before, q:after { - content: ''; - content: none; } - -/** - * Address `quotes` property not supported in Safari 4. */ -/** - * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; } - -/** - * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; } - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; } - -sub { - bottom: -0.25em; } - -/* ========================================================================== - * Lists - * ========================================================================== */ -/** - * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; } - -dd { - margin: 0 0 0 40px; } - -/** - * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; } - -/** - * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; } - -/* ========================================================================== - * Embedded content - * ========================================================================== */ -/** - * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; } - -/* 2 */ -/** - * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; } - -/* ========================================================================== - * Figures - * ========================================================================== */ -/** - * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; } - -/* ========================================================================== - * Forms - * ========================================================================== */ -/** - * Correct margin displayed oddly in IE 6/7. */ -/** - * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; } - -/** - * 1. Correct color not being inherited in IE 6/7/8/9. - * 2. Correct text not wrapping in Firefox 3. - * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; } - -/* 3 */ -/** - * 1. Correct font size not being inherited in all browsers. - * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * and Chrome. - * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; } - -/* 3 */ -/** - * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * the UA stylesheet. */ -button, input { - line-height: normal; } - -/** - * Address inconsistent `text-transform` inheritance for `button` and `select`. - * All other form control elements do not inherit `text-transform` values. - * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; } - -/** - * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * and `video` controls. - * 2. Correct inability to style clickable `input` types in iOS. - * 3. Improve usability and consistency of cursor style between image-type - * `input` and others. - * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * Known issue: inner spacing remains in IE 6. */ -button, html input[type="button"] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; } - -/* 4 */ -input[type="reset"], input[type="submit"] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; } - -/* 4 */ -/** - * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; } - -/** - * 1. Address box sizing set to content-box in IE 8/9. - * 2. Remove excess padding in IE 8/9. - * 3. Remove excess padding in IE 7. - * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ } - input[type="checkbox"], input[type="radio"] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; } - input[type="search"] { - -webkit-appearance: textfield; - /* 1 */ - /* 2 */ - box-sizing: content-box; } - input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { - -webkit-appearance: none; } - -/** - * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * (include `-moz` to future-proof). */ -/** - * Remove inner padding and search cancel button in Safari 5 and Chrome - * on OS X. */ -/** - * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; } - -/** - * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; } - -/* 2 */ -/* ========================================================================== - * Tables - * ========================================================================== */ -/** - * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; } - -/* - * - *Visual Studio-like style based on original C# coloring by Jason Diamond */ -.hljs { - display: inline-block; - padding: 0.5em; - background: white; - color: black; } - -.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { - color: #008000; } - -.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { - color: #00f; } - -.xml .hljs-tag { - color: #00f; } - .xml .hljs-tag .hljs-value { - color: #00f; } - -.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { - color: #a31515; } - -.ruby .hljs-symbol { - color: #a31515; } - .ruby .hljs-symbol .hljs-string { - color: #a31515; } - -.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { - color: #a31515; } - -.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { - color: #2b91af; } - -.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { - color: #808080; } - -.vhdl .hljs-typename { - font-weight: bold; } - -.vhdl .hljs-string { - color: #666666; } - -.vhdl .hljs-literal { - color: #a31515; } - -.vhdl .hljs-attribute { - color: #00b0e8; } - -.xml .hljs-attribute { - color: #f00; } - -.col > :first-child, .col-1 > :first-child, .col-2 > :first-child, .col-3 > :first-child, .col-4 > :first-child, .col-5 > :first-child, .col-6 > :first-child, .col-7 > :first-child, .col-8 > :first-child, .col-9 > :first-child, .col-10 > :first-child, .col-11 > :first-child, .tsd-panel > :first-child, ul.tsd-descriptions > li > :first-child, -.col > :first-child > :first-child, -.col-1 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child { - margin-top: 0; } - -.col > :last-child, .col-1 > :last-child, .col-2 > :last-child, .col-3 > :last-child, .col-4 > :last-child, .col-5 > :last-child, .col-6 > :last-child, .col-7 > :last-child, .col-8 > :last-child, .col-9 > :last-child, .col-10 > :last-child, .col-11 > :last-child, .tsd-panel > :last-child, ul.tsd-descriptions > li > :last-child, -.col > :last-child > :last-child, -.col-1 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child { - margin-bottom: 0; } - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; } - @media (max-width: 640px) { - .container { - padding: 0 20px; } } - -.container-main { - padding-bottom: 200px; } - -.row { - display: -ms-flexbox; - display: flex; - position: relative; - margin: 0 -10px; } - .row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; } - -.col, .col-1, .col-2, .col-3, .col-4, .col-5, .col-6, .col-7, .col-8, .col-9, .col-10, .col-11 { - box-sizing: border-box; - float: left; - padding: 0 10px; } - -.col-1 { - width: 8.3333333333%; } - -.offset-1 { - margin-left: 8.3333333333%; } - -.col-2 { - width: 16.6666666667%; } - -.offset-2 { - margin-left: 16.6666666667%; } - -.col-3 { - width: 25%; } - -.offset-3 { - margin-left: 25%; } - -.col-4 { - width: 33.3333333333%; } - -.offset-4 { - margin-left: 33.3333333333%; } - -.col-5 { - width: 41.6666666667%; } - -.offset-5 { - margin-left: 41.6666666667%; } - -.col-6 { - width: 50%; } - -.offset-6 { - margin-left: 50%; } - -.col-7 { - width: 58.3333333333%; } - -.offset-7 { - margin-left: 58.3333333333%; } - -.col-8 { - width: 66.6666666667%; } - -.offset-8 { - margin-left: 66.6666666667%; } - -.col-9 { - width: 75%; } - -.offset-9 { - margin-left: 75%; } - -.col-10 { - width: 83.3333333333%; } - -.offset-10 { - margin-left: 83.3333333333%; } - -.col-11 { - width: 91.6666666667%; } - -.offset-11 { - margin-left: 91.6666666667%; } - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; } - .tsd-kind-icon:before { - content: ''; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); } - @media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; } } - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; } - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; } - -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; } - -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; } - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; } - -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; } - -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; } - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; } - -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; } - -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; } - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; } - -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; } - -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; } - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; } - -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; } - -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; } - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; } - -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; } - -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; } - -.tsd-kind-external-module > .tsd-kind-icon:before { - background-position: 0px -102px; } - -.tsd-kind-external-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; } - -.tsd-kind-external-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; } - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; } - -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; } - -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; } - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; } - -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; } - -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; } - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; } - -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; } - -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; } - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; } - -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; } - -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; } - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; } - -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; } - -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; } - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; } - -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; } - -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; } - -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; } - -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; } - -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; } - -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; } - -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; } - -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; } - -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; } - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; } - -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; } - -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; } - -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; } - -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; } - -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; } - -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; } - -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; } - -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; } - -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; } - -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; } - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; } - -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; } - -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; } - -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; } - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; } - -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; } - -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; } - -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; } - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; } - -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; } - -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; } - -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; } - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; } - -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; } - -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; } - -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; } - -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; } - -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; } - -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; } - -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; } - -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; } - -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; } - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; } - -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; } - -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; } - -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; } - -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; } - -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; } - -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; } - -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; } - -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; } - -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; } - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; } - -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; } - -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; } - -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; } - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; } - -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; } - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; } - -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; } - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; } - -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; } - -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; } - -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; } - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; } - -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; } - -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; } - -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; } - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; } - -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; } - -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; } - -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; } - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; } - -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; } - -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; } - -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; } - -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; } - -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; } - -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; } - -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; } - -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; } - -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; } - -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; } - -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; } - -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; } - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; } - -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; } - -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; } - -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; } - -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; } - -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; } - -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; } - -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; } - -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; } - -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; } - -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; } - -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; } - -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; } - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; } - -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; } - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; } - -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; } - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; } - -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; } - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; } - -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; } - -.no-transition { - transition: none !important; } - -@keyframes fade-in { - from { - opacity: 0; } - to { - opacity: 1; } } - -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; } - to { - opacity: 0; } } - -@keyframes fade-in-delayed { - 0% { - opacity: 0; } - 33% { - opacity: 0; } - 100% { - opacity: 1; } } - -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; } - 66% { - opacity: 0; } - 100% { - opacity: 0; } } - -@keyframes shift-to-left { - from { - transform: translate(0, 0); } - to { - transform: translate(-25%, 0); } } - -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); } - to { - transform: translate(0, 0); } } - -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); } - to { - transform: translate(0, 0); } } - -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; } - to { - transform: translate(100%, 0); } } - -body { - background: #fdfdfd; - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: #222; } - -a { - color: #4da6ff; - text-decoration: none; } - a:hover { - text-decoration: underline; } - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: rgba(0, 0, 0, 0.04); } - -pre { - padding: 10px; } - pre code { - padding: 0; - font-size: 100%; - background-color: transparent; } - -.tsd-typography { - line-height: 1.333em; } - .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; } - .tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; } - .tsd-typography h5, .tsd-typography h6 { - font-weight: normal; } - .tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; } - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; } - html.default .col-menu { - width: 28%; } - html.default .tsd-navigation { - padding-left: 10px; } } - -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: #fff; - transform: translate(100%, 0); } - html.default .col-menu > *:last-child { - padding-bottom: 20px; } - html.default .overlay { - content: ''; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; } - html.default.to-has-menu header, - html.default.to-has-menu footer, - html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; } - html.default.from-has-menu header, - html.default.from-has-menu footer, - html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; } - html.default.has-menu body { - overflow: hidden; } - html.default.has-menu .overlay { - visibility: visible; } - html.default.has-menu header, - html.default.has-menu footer, - html.default.has-menu .col-content { - transform: translate(-25%, 0); } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); } } - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: #fff; - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); } - .tsd-page-title h1 { - margin: 0; } - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: #808080; } - .tsd-breadcrumb a { - color: #808080; - text-decoration: none; } - .tsd-breadcrumb a:hover { - text-decoration: underline; } - .tsd-breadcrumb li { - display: inline; } - .tsd-breadcrumb li:after { - content: ' / '; } - -html.minimal .container { - margin: 0; } - -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; } - -html.minimal .content-wrap { - padding-left: 300px; } - -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; } - -html.minimal .tsd-member .tsd-member { - margin-left: 0; } - -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; } - -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; } - -html.minimal footer { - background-color: transparent; } - html.minimal footer .container { - padding: 0; } - -html.minimal .tsd-generator { - padding: 0; } - -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; } - html.minimal .content-wrap { - padding-left: 0; } } - -dl.tsd-comment-tags { - overflow: hidden; } - dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid #808080; - color: #808080; - font-size: 0.8em; - font-weight: normal; } - dl.tsd-comment-tags dd { - margin: 0 0 10px 0; } - dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; } - dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; } - dl.tsd-comment-tags p { - margin: 0; } - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; } - .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; } - -.toggle-protected .tsd-is-private { - display: none; } - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; } - -.toggle-inherited .tsd-is-inherited { - display: none; } - -.toggle-only-exported .tsd-is-not-exported { - display: none; } - -.toggle-externals .tsd-is-external { - display: none; } - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; } - .no-filter #tsd-filter { - display: none; } - #tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; } - #tsd-filter input { - display: none; } - @media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: #fff; - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; } } - -footer { - border-top: 1px solid #eee; - background-color: #fff; } - footer.with-border-bottom { - border-bottom: 1px solid #eee; } - footer .tsd-legend-group { - font-size: 0; } - footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; } - @media (max-width: 900px) { - footer .tsd-legend { - width: 50%; } } - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; } - .tsd-hierarchy .target { - font-weight: bold; } - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; } - -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; } - -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid #eee; } - -.tsd-index-panel ul.tsd-index-list { - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; } - @media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; } } - @media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; } } - .tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; } - -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: #9600ff; } - -.tsd-index-panel .tsd-parent-kind-interface a { - color: #7da01f; } - -.tsd-index-panel .tsd-parent-kind-enum a { - color: #cc9900; } - -.tsd-index-panel .tsd-parent-kind-class a { - color: #4da6ff; } - -.tsd-index-panel .tsd-kind-module a { - color: #9600ff; } - -.tsd-index-panel .tsd-kind-interface a { - color: #7da01f; } - -.tsd-index-panel .tsd-kind-enum a { - color: #cc9900; } - -.tsd-index-panel .tsd-kind-class a { - color: #4da6ff; } - -.tsd-index-panel .tsd-is-private a { - color: #808080; } - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: #fff; - background-color: #808080; - text-indent: 0; - font-size: 14px; - font-weight: normal; } - -.tsd-anchor { - position: absolute; - top: -100px; } - -.tsd-member { - position: relative; } - .tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; } - -.tsd-navigation { - margin: 0 0 0 40px; } - .tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: #222; - text-decoration: none; - transition: border-left-color 0.1s; } - .tsd-navigation a:hover { - text-decoration: underline; } - .tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; } - .tsd-navigation li { - padding: 0; } - -.tsd-navigation.primary { - padding-bottom: 40px; } - .tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; } - .tsd-navigation.primary ul li a { - padding-left: 5px; } - .tsd-navigation.primary ul li li a { - padding-left: 25px; } - .tsd-navigation.primary ul li li li a { - padding-left: 45px; } - .tsd-navigation.primary ul li li li li a { - padding-left: 65px; } - .tsd-navigation.primary ul li li li li li a { - padding-left: 85px; } - .tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; } - .tsd-navigation.primary > ul { - border-bottom: 1px solid #eee; } - .tsd-navigation.primary li { - border-top: 1px solid #eee; } - .tsd-navigation.primary li.current > a { - font-weight: bold; } - .tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: #808080; } - .tsd-navigation.primary li.globals + li > span, - .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; } - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: .3s; } - .tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: .5rem; } - .tsd-navigation.secondary ul { - transition: opacity 0.2s; } - .tsd-navigation.secondary ul li a { - padding-left: 25px; } - .tsd-navigation.secondary ul li li a { - padding-left: 45px; } - .tsd-navigation.secondary ul li li li a { - padding-left: 65px; } - .tsd-navigation.secondary ul li li li li a { - padding-left: 85px; } - .tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; } - .tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; } - .tsd-navigation.secondary ul.current a { - border-left-color: #eee; } - .tsd-navigation.secondary li.focus > a, - .tsd-navigation.secondary ul.current li.focus > a { - border-left-color: #000; } - .tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: #eee; } - .tsd-navigation.secondary li.current > a { - font-weight: bold; } - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; } } - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: #fff; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } - .tsd-panel:empty { - display: none; } - .tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid #eee; } - .tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; } - .tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; } - .tsd-panel table th { - font-weight: bold; } - .tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; } - .tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; } - .tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; } - -.tsd-panel-group { - margin: 60px 0; } - .tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; } - -#tsd-search { - transition: background-color 0.2s; } - #tsd-search .title { - position: relative; - z-index: 2; } - #tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; } - #tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: #222; } - #tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; } - #tsd-search .field input, - #tsd-search .title { - transition: opacity 0.2s; } - #tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } - #tsd-search .results li { - padding: 0 10px; - background-color: #fdfdfd; } - #tsd-search .results li:nth-child(even) { - background-color: #fff; } - #tsd-search .results li.state { - display: none; } - #tsd-search .results li.current, - #tsd-search .results li:hover { - background-color: #eee; } - #tsd-search .results a { - display: block; } - #tsd-search .results a:before { - top: 10px; } - #tsd-search .results span.parent { - color: #808080; - font-weight: normal; } - #tsd-search.has-focus { - background-color: #eee; } - #tsd-search.has-focus .field input { - top: 0; - opacity: 1; } - #tsd-search.has-focus .title { - z-index: 0; - opacity: 0; } - #tsd-search.has-focus .results { - visibility: visible; } - #tsd-search.loading .results li.state.loading { - display: block; } - #tsd-search.failure .results li.state.failure { - display: block; } - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid #eee; - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; } - .tsd-signature.tsd-kind-icon { - padding-left: 30px; } - .tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; } - .tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; } - .tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; } - .tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; } - -.tsd-signature-symbol { - color: #808080; - font-weight: normal; } - -.tsd-signature-type { - font-style: italic; - font-weight: normal; } - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid #eee; } - .tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; } - .tsd-signatures .tsd-signature:first-child { - border-top-width: 0; } - .tsd-signatures .tsd-signature.current { - background-color: #eee; } - .tsd-signatures.active > .tsd-signature { - cursor: pointer; } - .tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; } - .tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; } - .tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; } - .tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; } - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - transition: height 0.3s; - padding: 0; - list-style: none; } - ul.tsd-descriptions.active > .tsd-description { - display: none; } - ul.tsd-descriptions.active > .tsd-description.current { - display: block; } - ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; } - ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; } - ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; } - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; } - ul.tsd-parameters > li.tsd-parameter-siganture, - ul.tsd-type-parameters > li.tsd-parameter-siganture { - list-style: none; - margin-left: -20px; } - ul.tsd-parameters h5, - ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; } - ul.tsd-parameters .tsd-comment, - ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; } - -.tsd-sources { - font-size: 14px; - color: #808080; - margin: 0 0 1em 0; } - .tsd-sources a { - color: #808080; - text-decoration: underline; } - .tsd-sources ul, .tsd-sources p { - margin: 0 !important; } - .tsd-sources ul { - list-style: none; - padding: 0; } - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: #333; - background: #fff; - border-bottom: 1px solid #eee; - transition: transform .3s linear; } - .tsd-page-toolbar a { - color: #333; - text-decoration: none; } - .tsd-page-toolbar a.title { - font-weight: bold; } - .tsd-page-toolbar a.title:hover { - text-decoration: underline; } - .tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; } - .tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; } - .tsd-page-toolbar .table-cell:first-child { - width: 100%; } - -.tsd-page-toolbar--hide { - transform: translateY(-100%); } - -.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { - content: ''; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; } - @media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; } } - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; } - .tsd-widget:hover { - opacity: 0.8; } - .tsd-widget.active { - opacity: 1; - background-color: #eee; } - .tsd-widget.no-caption { - width: 40px; } - .tsd-widget.no-caption:before { - margin: 0; } - .tsd-widget.search:before { - background-position: 0 0; } - .tsd-widget.menu:before { - background-position: -40px 0; } - .tsd-widget.options:before { - background-position: -80px 0; } - .tsd-widget.options, .tsd-widget.menu { - display: none; } - @media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; } } - input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; } - input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; } - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; } - .tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; } - .tsd-select .tsd-select-label:before { - background-position: -240px 0; } - .tsd-select.active .tsd-select-label { - opacity: 0.8; } - .tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; } - .tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; } - .tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: #fdfdfd; } - .tsd-select .tsd-select-list li:before { - background-position: 40px 0; } - .tsd-select .tsd-select-list li:nth-child(even) { - background-color: #fff; } - .tsd-select .tsd-select-list li:hover { - background-color: #eee; } - .tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; } - @media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; } } - -img { - max-width: 100%; } diff --git a/website/static/api/assets/custom.css b/website/static/api/assets/custom.css new file mode 100644 index 00000000..a506d7fa --- /dev/null +++ b/website/static/api/assets/custom.css @@ -0,0 +1,47 @@ +footer { + text-align: center; + border-top: none; +} + +.footer-hr { + width: 100%; + border: none; + border-top: 1px solid var(--color-accent); + margin: 0 0 1rem 0; +} + +.footer-links { + list-style: none; + display: flex; + flex-wrap: wrap; + gap: 0.25rem 1.5rem; + padding: 0; + margin: 0 auto 0.75rem auto; + justify-content: center; +} + +.footer-links a { + color: #337ab7; + text-decoration: none; + font-size: 0.875rem; +} + +.footer-links a:hover { + text-decoration: underline; +} + +.copyRight { + font-size: 0.8rem; + color: var(--color-text-aside); + margin: 0 auto 0.5rem auto; + max-width: 80%; +} + +.copyRight a { + color: #337ab7; +} + +.docs-generated { + font-size: 0.75rem; + color: var(--color-text-aside); +} diff --git a/website/static/api/assets/favicon.ico b/website/static/api/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..b8bf6c275dafb0ed438f43a846a99f35df4e8312 GIT binary patch literal 1150 zcmbVM>q}E%96mwc`XYVkv-Lp-MMycV+}fnI*t)nWyCA58a&0SWHp6*YsSwRcE^?-8 zR8lIfvWpthACMnw;RhE{q9sILXzF0Mv!`?3vllk01-<8--+P|l<$WH0zr$geZQNB* zz;L#Zv216UT@1sBxQBCb9>LFT48z5C?hqb=IfJZ~PN%`LEb%1cNz~Nouv@to?`CF* zFOf`SW#_)~wftK8wglImZglx?f3hRwaDAW`|(OUzRNe_{w6e_nK ziS@W}Mn*3WD1R&#L!;A%WFiSqzZb=ZQ!x4cFbxghpi6=C{g=69{?6s6I{1BU?H7T4 zfoT{!zoM=u0*fz>s;dJCP6SCT#s0k+sZ9UF;d#iVt3&F$g2#uFyAd@IWV3OdNlfU80VgQar4a>BFig6PFCM?iZX!C zV&%s&>N_srdT0vH@dsF(UmzKIwP*VJI5>t!7fvm3zW!=XiajMWd z)QOGtjlAc8Yj2a+36cE}jsMMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/website/static/api/assets/icons.svg b/website/static/api/assets/icons.svg new file mode 100644 index 00000000..50ad5799 --- /dev/null +++ b/website/static/api/assets/icons.svg @@ -0,0 +1 @@ +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/website/static/api/assets/images/icons.png b/website/static/api/assets/images/icons.png deleted file mode 100644 index 3836d5fe46e48bbe186116855aae879c23935327..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9615 zcmZ{Kc_36>+`rwViHMAd#!?~-${LfgP1$7)F~(N1WKRsT#$-?;yNq3ylq}iztr1xY z8DtsBI<`UHtDfii{r-60Kg@OSJ?GqW=bZ2NvwY{NzOLpergKbGR8*&KBGn9m;|lQC z2Vwv|y`nSufCHVQijE2uRauuTeKZL;=kiiF^SbTk;N^?*u%}Y7bF;O-aMK0lXm4nb zvU~Kf+x|Kgl@Ro%nu?L%x8-yetd((kCqY|t;-%}@Y3Ez_m(HTRt=ekeUQ2n4-aRvJ zrlKaWct8JSc8Kxl4KHu+3VW1L`9%n~_KC5}g6&tFXqyKT-}R0?EdkYqCmQot47^9Z z6;opqR@7Nq-s|6=e6*0^`}+X1kg>CpuGnbpL7{xFTa|8nymC0{xgx*tI7n4mTKZNA znsd@3eVsV>YhATuv~+5(^Vu4j?)Tn`{x@8ijIA;wdf`+0P3$vnSrcWFXXc{Lx`1Z7 z%-n(BM(owD$7LzqJx)(f^Cusecq>OW z=h6n4YzSVM-V!-DK(sLT`!W~}($=O$9|ie`>_fpH0=1G1tiIFw($?~{5T>`74|p0H z``5=UydE)!CiFvmECW|s^TzG9*7pN|KknkVm3C{fEu30gffX&8iCm? zTFPm6*k%Hog`Q6JGj@dg9Z5nlAc6ApUe>;6xauB0-u!?wMU92jVL|3EcP9gEu5^wH z%tXRy#>HCEs*?KgMf73UcJ!lJ?x<6+)eJ{mEIS|HMDP7(7!(< z@X;?ACT8mncW9*XIaiJPW}Mw@b0W||)!sYnLw)0j4&-rXQgJhnQ2?frg1Nfk&JpmV8F=dDZl)e%#Grs|&0th7_o) z?7hQn<1078qcq?#;)CH=2kBBiGt37EtcXfpTXtHB59dr9=B~jI`yPm-Q?(ys=ajAu zGY;eS^z&WFvztZI3I~}*l}_lI^}6D<&CZ94;|&G9_pMx!C~$~EL4^8`QjT#|tqxxk zhl4CdxppbDiOk!Ht#SVAK4gf6Cr#=U&1sVxZ`y-X zTSi#@wHf(?(Dd6ypNOyshRZ*tneVP^W?y?$ur_!9iD-vY{&Q5(ooX2;`SkUjwEYA~ zwGcylCT4_`MZobm(0v$U(IhfYXxyjNJ@ztpH0sDmfpn|LMp3eM(R4uqKi_q1=D1-d z%GdV<&2+_9k@sc44xhIjqktRA2!Su|vzM0R-@#MK&{RdLoU#$Hc?{{JItvX{hKCtc zQNqZpkfG^@LGJRZM4H_>`F=N;O*+_`>M_ko_XWCgu@}ntqLX8VSeZQ_25Z8|^!d?o z$~}~9|`ZW9d_o<=8&K^~;Cr08b;qgq{(*e*sNt00lO2lZ;m-b<`Rl}=Lr6iQ8+$&br z!RLn{5a}j1Dh^|_1)Q?<;iBSrS0V|c_D@3}mc2d!%tV1VN?BC@clkFdx?HB&9KOTF z)9eHpmUEYsCqx^%JHuNdwY zz9P3oPYuTAXZVY}LRp&2qNl$pbsXL1GJ@wx?@CTO!acs+OFfW_U6?&As-(GJED}RR zO}B+Kxph7aUUm>i3rbPZQGXN}oQq;u`yTnFDAJ*d$4gjEJH!JPyt6V{cOUp*Jbyol zE$8wh)T=vpJOWRbv}HvR(cUSlO}ePIPdJ`J@yp=IC&E6K%r?QfW7F&%p!H~@?%yj5 z&MpiV!hyfukD56A097f!0+ANt`JSB~oLak75oKQN7FH=rQbX#Eak37|4&mqp@S~TA zOo51)xQxX}5NQ(3I_UeR4B;P0Q#x$_lDce78ET`Blo;`Hj*R;b8slZS7Oak(LjDuE z3z?-~-U@vWe*cEOsf^9|duH9};Pe)!=Ky+QQ!jr2VV-jMUH-F>oB>Ds zDJw}jm%V?OT^fu1y`$`yRdaW03L?)6vmInxhAsGrPhWIP8?=speMFf9Inn4^t zs$!88*B~c1A2J6t0~hgK2BJ_Pl23l=oeQQqjI2(4Mcv6U_#9#$PEN|qz36rCZ5$@I zNF1LpRe%ZG4qwuYr7ZdaynrPs?spt;9VbQM$462zbksMVhAOqPunrR7@Nbv#5;VKk zJB7xC?~QXd(e9REiLixHxRGhLcKR#0va}|LMS`AXKGOIGFKQv?=+>zf^ zN5XLjX6^`zh*%1UG_QV1H`@z!HZgC+OT2`+_B( z)J95hk;3C+K4XCswSP}au;fx=47~*$k`RAaYEU-qb03y0#x|&>LAeiXgri5E(!h9k z|9OVt@sk1-4+>0?ELyw|zs`~<95M=%o?Gix$?8z4Gz3Kpw|b>?BcD&s{X)-aXg!GJ zyq&`ZEP{K^u7ActXP$gGnO#F0Sr+QUZe0&d5*Yhw9A?C4(Sx2j3QKAlUpkQz7nji^ z%y8F|W{ypj(T%Bf#Wgyvq4szMo?*U-;3IGBRg1fK9!h-=YRsZ_+t~2!-)=pr;)Vnk zmt95&wMb02toOf`I9>M^Kv3LqKb_-#jauF&cGrWsCnMt?p7*uh zevugda={D04DB#7wR375=1i5}Z9fi3r)!F#7qmX9`SjppE&%8l8bKt+ADRMTWRv21 z4L&PldV8YpHw3b^`p0uWlIm#J&K65-y4lQW0VzZR!4#gfeT{b#fL1e*)Z*Ux}M^}bO%OM7uXip_4! zL@yo@q{utZeVV?3CtXs}i>nI|%26fwuzt0f#96fQ!{=dEX^YKnvIk*D%y9Cin;9R) zi{?)baJhgFs$1$SOZESTpldw2H&FD=v*v@1cA!`|s;avDKHa>Q+uJ8qhy!9%C4&lJSTN4OeydYOm4S?Bj7*e{xRYbU9Xos)R7qZT3dBBD5{ zo+(E3pR{>>)}hFhE+}!yYP0V+CVhyAq+RV{^X`XA3{iXj(ir$k@u|t8ZJ1ZnHq2dd zD$0RHmGJ=!?T5`*T2zOEJ~y}Nsyt7O)%+!0ulRQdsopJJxoznfpusv=2@zLXIq@^& z>0T5k4lzGCG(DnltLIe@6=ZOG@C(dvmYXfh4IhJfMfY8S?KkT znb7~EDE}Yhg$J1LxB7m`L4VMS(+(SXTQvh_mz!x&M3-6Z zFRB*a%_gVEqI^mL5|c%V=l_oi%|~h>gL0SB4QH5uonWd#={KPg6}6ES)zk0~#3^KJ zJq@{iqbHe3gyC))jeQ`W;(u3|q)JxuF24|GMsh%v5>>VY-bok%* z1Yl@(5G2UCK=fQck}pAyWV0n{`ML|rsl_N7vmW|frii__zB;ozrQ7{z)y}M^Sg@m_ z;+?{q3sUZs3WxnBbp~CyyL(TA?C*0KIeDPp7w0$!Ijd+M8#}r~vYW)NB*$mG*7-vH z@s^wK07OMxq>WveCEQFQ*p&2gjD1j%i+#G9z##Th`gew>H5=`RwyfPDg2G%f>x3@c z14Oy}pQK?(i06GWLWu%4cGjDoE-tTEI$`9^E?nLT663vu_>6K1e!N>A-^q&tfl$0& zy&>w~+yUelAa!c@xd8iyt^`B^$cj+}h}0i!40K2Ve1KFCDezBzZO8@=k&r)`TNTJ* zzF4Pim>SYL^=~7kW>EyiVHXNMT2)8l#v^IW!pLB_8ZvVfK&m8QHkjsZ)mvd?o$VYG zX#HiWwWlW>N{D85URJ-d)}_3h73|)X=E(6hFzi#TF{$4aSka4TeY>1a_(RIkFBL#O zE0_FoSQI)}+si51ufAqRHhDU=actTRQl@y#2h}xaDv-A&GP&0Qu9V4ED5aWnX z1E#mRT1QSvL!4~%Ozt84nP{&F>VIm6w2q!EPhh^BF-94$4JhCTcrdbDXA3Q&8mPTh zqdPv|X}??B?bIZPpl}z%(zr<8U-NoXjb*L#xyqHHfpIGAgN$5i(E9#rYPYq_tISC4 z2TDkd*uZ;CIhVI2o!||T)Kz`ER@%rTf-&SfmJFF>;d(RW(B6k!1<)uxHM_1G+9BWe zc)k`gBxYMcztqY5@jccaU)CqQ@^G5TBVx(nNf2}D@);3+{D)GzyT{>%dO6ibggS({N!!=P4=M8J}5R*&fgd(w36z0M0D$ z(SN5a`i%sZ9vmaEjiC4)DF}ix&`?mc-vYwK@+}8Gqzj6r6y)lT|Iqwlpj(LXqvh;- zb>jECiiOZ%&Q7gQg7(ix-?-RE*c(O6NG0F-+VCr;701@%L~fyfHnU<;Vk`m3A2{1MSmpii@G*k?KDq0GdZ)|hd`8OHep z8@6wv_|9NKNpe*sc#?zZ1S#}*qk{k<(I99u6(QT#>wf9w^u9~9_>;2d20T=^g-;b5 ze9x~fHZ-JL=J`hq-;W{2SgN)&m9RsVo=%?`JYp`pxEA_>`18Y>XA$rfWm^pQfG3MQ zxT^I1*({tZz2}+!5$AyNUE*jiYwu_S8v<#qZS4e!bGGBdY`3RkgLMf%Kz8s-;7PF+ z6w#-FwV#)PiKGR79miXmrDyv=ZTjc)j>N=&h4F+#G;unBZhhZz?a*;8@bi5`fV4)O zuU5pCs;tvRzbV@P5%W5xLI4I+w*^KExeVlzP4kNRGp-wi3g$lf-I|(o`JQ|u^XfkP zcik+g-5~2lG*oHfjLCpfNalFwz=4ZY>$Rc-QGpws&tCfFZUuJDL)3et%ap*$Q=-v0 zgLfsn-&%#+wnox~@)6ppx30sK(UJg1dCAvQF&}DkoPI+uX_wH))iaYvWtl}BtVKpU&MN= z0GdENbhdLgIwL-#_phGK;mZRlk4zq8*)akvV5zRX@jFUmvcr#3p99P@4z@m|bz-)^ zbZl8Wt?hR*z(sEZl;2PaILIG#835i@YoZQ@EwrD9IOBl7BpJX(ilLgcd)KCZAzo^b z6Z{|~=H;$D2dD53tejr_jx7^y-zT{SNZpNjn4+wJQX~K#LcrlKOv=D5xk%QXD{tg; z+xh`PvMV*HC*rF?xyjK5@KsMl5*w`r@wL#r13uFpso~#^oYIFc^&gGNS825eqFttU2_sG%_ z;X8VXD#Ol4X&$2B_Z$*&-)ZIUXf9I%mOOXJ3O%GbGpJfl+9(jY^fF_(b!Gt{{HAA3 zusUOCPDHYT@&*H~7a050c7r-_CaFACp$BXx)5==@fC11Gn|n~~+u@6N-}lvdyl3&6 z<#c_zm0Xp1F!8o2OBbFfgzzC4vno}9XEf40dGaVo;jiwiazo8hZ~iPVD(re=5k;H| zotm286$6nnTeIw>1FY$Ri|t{Lp?o(Fg3g_>|y~Z+16tvyLc@r?t9g7 zBuXyVuu9bC#q`?@OFIhgS)6v^XP@H0ukl2X!RPMsg%`YHMGad z4{VsgxaprFss3X%HbZablb6IdaNdbISVWp7yQXPPn=s7?J9qLEH{4>XAv8}%h&TDg zs()1sh}4at3nL3^%q!?P9BbW80e*ZwU63}CV7pt}gVu;~V6c$9p+*wfhw!zeE-z|V z=k{Ksec2)$Hu&?pRh;*TPk0T$Fc~^oAoBT4q?-Q}Y&3DluXeoMQ0LesTk}pVlf5(I z$dl8;zA0&=L&z*F*H>W7IeiPhTo@P0VTB~vyC2Bm7lCN}t7@NNlKFSHGKkh?z_qij zoYju!#D4b28cdslLdIM5Cmqe&!v^IcRr=qq^?l+P^n@6}fh@)IS81hx)SPAY7osk0)^ulqC1F*{hBNQl+Y}b>XjVXnS_Cc!L zIZ@Jq#mp^E&fKT~t4DM_^S17R@YJ@`(7;zv1mz_Y=~q*Gdg#*yXGxotY=#F|lvhPM zjlE)VHS=8=)njE^c7M|ZiBqARx>9Ib!y91$70iC8jPi$c+ysP}5Q3s`ti&1sx>~oG zI^>^1onS%G`mtq&)cZ15dZ{X^#MOfatyH0I=l%Q)n z7*@kZtC_3?=J_}?_G@?F?UK<0_AhYFclyrS-PkfYhAeVHcF z16x+quy10*2V$A%p_|@C(vlf}j3uY83h(#TSr$(;^8(I={_=YQQWmA9-IlwJv>tQm z=vN-I{TO7X`;qBxwb5w$91YLV?ZD5}pddq(7IdMCH zi>`qAn|#FITi!L5;K!(tYm9r416}Wof}P8~?R9I9Gp(?VA;uQg19MO47*gS7fH*&jBO!+ zA*<^BMccHjJIvGHguBb4a`X z3aZw#!c&Xr8&szD1+gu&;vYfoWo>0Pxfr2%m34tC33fmRbzWF9I_Pqb9nNK@N##9_ z7K)v)des!^owH`MoXY_O?|;^9;comiPx0e78xhnnVvTYt+t+cU1rn_>gaFJsL-iPn)?<9P9cF#4)7q&v+d&6|3G@s-AcJy+m zE&u*GUaMK|x|4GmT(CgBICk`2BP@3rqtjKIRD#uBy}y*d;<>`?W&mGsG;i*_}V&^tlP`%;=g39@jxP z+3lrtg*!i6N;irOpUfKcd;iDl5a`<#kr8RwFm9=^m+ouwwjcXmTB}w5V#9IF^&Bl$ zr1$Ly#cQ<3u86>am9}pk&i%nxu(W&s@>qEDtn_xVtH-_EiQ}iAK4Ssfsdn&L9t=)d z`XOQN7*J)g$Jrtq0=-yeLnHg*23LxYA7$cxz^Yc)I6E-!;{LQwu_wfGw4&MYy7{n< z@{g0Hf)N5gAJKQ1Z&HGPn9x9B7U(m(9K&=+LHAc_D{YdMBZs~x)u1Y8|Oq!`C4(3_9<&$ddi6>R$Nsz z*ti?=jA-Sr_97V}feo+}Lq3-cfpgWR;PLI8s{ve9@?e;2o}0MpquOucipz^DrT}QH z*(<{nLb4h9799hx4&%I8KPj}xcQ}llgcaG1!nRb(PP?m)=CzA4v%6>oOe96H9 zv4mUhw`>V$29k?)$Co>qIqq(~3w4jJ;Hv5(RxjB-j_iEhlF;&|DDC|I8IcT>Vn;RY zhtw5mT0ygXAu=M%{^;GqYuYIMu4H;Mj--5CL}|zMEhOum_o51Y7i|D>$XmUFoe;@1 z%GsTUsKgF4w%-Cr3lg#~h)8;Lk%WQTLBS8r*sE{YBUDw4HU#o}E)8pVIEfWv&14?U z-+Za${OFm=>IA358en)nB5Iaqxw&Xi*ty@uDOX8o2c0tq0^sX>ZXD+Hn|;KY!Omm1 z^%wgf&Zy9Azd?vmU`~zuOOA0{TZ*mAC!_>|avcN83F#c+sFn_6tGo!v?95IUR2bL$ zlO(OlhszqAgy)mNt8PRulC#6u^SL#z-O&@{=_!AzBZ>T4ROorj%fx$A;u8u>saum0ha7p zeHRX-z)PW*@v9bruyAtVI@)PhaEs5kp`xyxTQ`U9$Whwz#z$=U$V|&0w@EfCUS!Ob zACSTE{VeC-0V~ZCpkKq~P4CLgdOeBy>vB+0ZxIt_Cp4aa%vI#LS^K}ui07WNo}5r0 zagMHmq-jqTf-OD<kAvu_ob1mUP%1jxeKqB!1&-)_hP{p74hHE%WM!atyx68j5b zSqwh8aKo|NIOL<2_eiX+iOsRP`{MUt{0iQetB*SL!F_8)_;0f$iJ4(o__4KWuvy_! z8TZ{dTb*rL6VmuN-yl2Z>0glL84u^jAH^DQl}VRI=x0CnuF*|;|My-5aPI;>(mo+m z`nyEOe&k$RG11$vEdDPG7^raBCw|#C*4#pIUoZJNx?4|ZC{)l>+jaSiiJ`GBKf}l) zUk1>%A61hqy!KvfRsM^|u6vwbH5WpfH(I5AdpBAg%rar%zW}nccGxfgRV4&v`tEoGyBq!uz^f zVqWEtxn%j&+Q2Fi$rL)H`M_HExP+?mFyN^){c{JXs{IM}f}p>7lfD zLZ;s)%6a(Ow@`(jP}k~pn@!dv6JhJkZf5UoumHv`g-tcCs)w* z#0sc%t9@Li{p}f*$vg$UiQ*RGZUr=ykDIaxRDU_(QfcURuYrpX*7IQcS$(Buw%VW7 zxaffDgn{-=K@iEh)LlPc3MPzc+qM^>RXr6Y8ASnP&dr6fqmwYILTpmh$E%{Iz%Qz( NZmR35l_G4O{0}dcmS_L~ diff --git a/website/static/api/assets/images/icons@2x.png b/website/static/api/assets/images/icons@2x.png deleted file mode 100644 index 5a209e2f6d7f915cc9cb6fe7a4264c8be4db87b0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 28144 zcmeFZcUTka`>%_-5TzIqq$xo`r3nZ`iiBRG(z{ZnN$)K|ii-3S5u{fmRRNLEoAh2n z@4X|01dtAA(50@mzH5K?{+)CF+}EWTz2eMdW-{;n-p}WG1C$hCWW;pD1Ox#ad~k9g4`y4!oVfq@3c(iW~uhy*`T7_0aH7`>`EnYuXVq#+YC==3#rnNM4TqqzM zpi2Elr!3hl!ZdK#y0bV+yVc8rwFEtAX3=QlvJ&e-EsBp)Q`0yKXbNuf-yYw7kh0CD z|Flk1UuHgvoR+*QR0ee&IDUfUzE7*`A=P$6nC;BPI@VJs|F#`Xc>X!`<6%M7XXNok zw^unt1h0m>-&2{GiIGsByulr92XZRrazZs&&M3jJintF7A}cE^uW4zt_r81yHt1I! z6-_gmO@78G3$})kfyhR0^qk?zev_%4R$qSjQI3MAg0)9EM#TOAD=_tf(*)S$7yiiR z&5v>wk3Bn**iD9S_I#2%^vi(^O+gpv2i^A);6^AcH%VC>0nH8|O!jN*L<#RtT z@aF9HMNu*d(BdiZq(LBO%(qsjSot+ZXQd{zLYh#CvOrK(?#u+|XYRylqcXOLk=m!) zBp`~~1dg7kF(Q#m)I8ZHMOD5%m&U)5jGOW@7+sm1N+O~^j*zRG;e4x@OteV=T4yo9 zSG`^0j^S)ZYp2DT>}AR|n$S)4FPI#8#(R~;Y**AZ9`&yqT;p`rks7Nhz;)dn-TgXU zw!^Bo@W6|jfp@}ijsSEFo#x3LnG;`o_yXK@2KuG8cTv&K@=dU?_PK*6=YU9!Ix8l;<_!y*Qc2phVpLM}&t|CuHBv&{M$K?VXtTabi(7kUMwV zl!>5cDNNqK6`Br*B~EcVh#5Z!FgiJZBN5nzpC7?UdAc+&AT0ivd;DA2$@YXMPK6=< z+#U~?*!R0i`3uu|#zDrRRN&j-j>ZOu#h-n#7WO^)@0> zCT6a$LGWwFLcPfN=(3#6`*UIS%uIT=LIXV-RbGE&!!+8)q~dkx`l{aKCe1`{J<5&< zlhRo;JX-UC>5)X;mwR+W96`@&ucHp$jIb~B_w_=mH>In?BLume!Wta=`ca+&7~pek zBVD?f5{nelCaje~EtZn+g3%5GJF}R_b`q}IH$Iom2IRD$^h*R)Cid8Q5~4Dzm!P&Q z<`iI)4wA#l@TwjPL)*9k5Vc!!;`9;bf?HRMm86wi9LI8A%*NGep3g11H{aP)>%l2Q zRMMQU!*0J$hJI5Qs3b=6?}qR7O;BU%Yzufc*ZKBV`}ro7zm=C?OY6Vlabc^r6r7P> z?1c^jD{e4n*Ou441V=Pd1eE8utX@)G5gq72HQAXLZ4l2wKd@yIYC+s) z-mu`E`kj=B!)a^B;pecv4W5oh>_tpj>^NU8L*eH4EhcOxQ|);$x(z(Yb5^tudSptV z%8z{(h@_t`chWkvFX=r!p~Vjhf1AdM>uGK05$1fyLb5D7m0!MUKW=JTZv)bXz9~*F z$yP@U3UE0=$;yjWr8b7C(1^oNDMZVxYYeMtL}ZnvQDkm>S0)=r_ugabEZ}AJ<<_Fu z{I^KKIz+V8K|pK811W5r##z8^S*2fr9Ln zlRG?Zzz8;xu9VSE8s+=(!^TGi1P2hC7%7MUqF=cZqFBtJNW9BROV ziv0cjsUmVvsU^X!`1UivK|dy+fSG$3YH8W0`q${`)taBT9jV{Hfh|&RIaJVvqRIFh zC*Rmvl&3*;XcMiJZ-+Mvfe0xN4N?AvJeABnNdgs(BYb!fK5<1)5UvM!Tz4_aojmUX z#Ymoh)m%fN(>6|#*RP~Lxt1?5);w}yT_lftje3sidO&MxNgcMg9@S+>M%s~y)0i`8 zT_+7LrZ~d<7V^K^C^~ast~@nM04^c5dw*&660^p%^R>n4xzd&jo)Y@ z1r=F09>jFOr%wsj^a3;>N!{rvf(qpkAdWM*5IYCsuwNwoJh7;9I$#`T6-NUIEKsiS;OylQ(XY zQtCiR1dyEGJV=~|zaFOEveB&szAVx*wsyuY?hiBGWR{h0!D zv;G`;F9cnib*YxugasrI^%uy@i)>BvC4V8@! zwy5#iHC#Qar(i0EPA3CuMQbaKy4m$CLjLSNwJs!13b%h{&x7479bv{SjC&3?SO&)3 z6q4nRRP(zOfw-mQrmx@Z64~o}GNXa9YCE$vD-(CLseaF%6HH+WZz4 zbRiJ~zAtA6*i9;z!+zZ?9~V0Lr66|Ae;}U1e#6D^hMhB6XJNHZi{t>DgU&jb=#rPK z@s04Hr_SOr%UCRY_SdDuSw^D*Rzre~4PCqgc)DBYam}@G^TxsTqX%w-yWtYU-Q2IX-a2Z4Kz_-yIe`m;x2bY1F?XZoIH=`uW{$R)ICXxqU$- zG#M6s!fDZwUOA_cs|PXe1T@XN3^UdYyR*t}943A1dTvXp!=%8c%)(s)5y@OJ@@%1a ztlq}Uvhfo3^ZO>ZO|NKfu37JMRRmXfJ_*VOBVnxFFmbq!zc%A+R+w|={11?sJpmca zCeCi;;-*yO)ywzKxa#q?E%@U-+LGH4{=2|reRd-Kz*Ps1$u6sPFO>{K9^k2Y!@=h7rZt472^BCU& z|0MZmbh1HlC3#bcjoX#m73R?H>6oW=45{gu0$S>j`v?``ch#0kGur}QbO_gO3XrB- zS4pz-Yrnqqt-k_LE-&~ox9gd#^n&HE%Z~grM;N@Das8-#U304PA$v*rj36j~qQzYN zsX>8?%q9DhpxrWR@M>30YI^WUDh4bcn+*bYn;~zt_g`$3{#G+=lBmWE;j}5e&vlDa zjsdE(Xg^o(Z|3$Tx>~-q5NrZ}^$y0eMd|h`7Y4OWkgF0(Cu&CfJV03AKfzSGBhMU4bqd4kc`qE!CH4Q^FdOCtUHaZW3R&>S}$! zhk=OYL~3fch$-?wa0)OEkynDzJR=vc^vuUQ$hF(>E(q3{7{4uhC^f@bzHUZT>k%%R zsekA}E`OlGE(x+lP1smp0;Ba7{C$F=@Pp~i$AsJkc)x+3Vf9xQB=aSN>D!T;Y5iU~39#6yoQuj6Bj%kdYC z`72YjnSoF_A)d#@S`|;~F|6TOn%b{4?MWJC4uG&NK=D zqd0rU$A@62MtWD$=Gg>TgO6)b6Vf41#Au&Zq<@p1RG!t}NG8kv#>%{bHuCdAeIao2 zkWX{dyO`XCdv`FlK?jS{48~Uaz;oD6PtoFF0u6HBTHCHh<)5wP<r?9UIw%{psu)`l~*PK0?1^oH}d{D_wF{En-ejdBHTK|(*2$K?xVkG zwYXl8^HAjVOqKQj0f6s~O`)Slp+alXd8@#4Iw?pHys|MW1|l%ipCPeN)|fLB$Dc(9s}LNw@?8G{ zU>U(Vid5}ltIy~zNv>o09)rC()g8O`<5~!qF*Z_?L;+2Sy!WSv=}|67mnOPb!A*2; z^f>okkk+f3+9?Tg&6NBMX%;BtB3Ds#(PZ6E4`X0e`~amc=9QGw3J-$!nw6)l1A8;m zFdl>D?g@J3P-41+3N`R32d*Hq0GWj!{3n&rVA)dpcB+|5`XZFFZI1bKA7d;-x=0wt zy;$6nvCJ$_&JDjWa%`LQYq&(6LqBP7G_+`+4$|qk7IlS4wK{qnP-3!yFO%_fw(8(Q(#|htD?ECEYPeT&anf%0GjGQC<0)vR3x=4pq`@gX z{0?*O(e3p_zu@N9G2O%!F8j&|FRhF(c@BWMxZTpdW0xv^K!`2L39%+Hs0#R>a@n-J#u*kF6~?DIhPrUi@$pR0tS?5wF%PE z(-eYCc#{7tVRzd>j~xO&LBPK62xxwmxrdd{N6!G1hfD0H?fV)_B^PBIm|@~CZXnpdaM=<+?&D8Md^RL00JfP zK|cm@`4bB6muuN!Zck2>k+wh^8kM73#1(%6#^TG;42H{?eTC(h^zB32g{Skc%t3Dn zcHX3$TQhR}n9xXCd$?igvlBH@ZU~p4OO*Gf=$@=w?9vYs)!RYa9V@}xVt8Sr4y_!< zGjn5?gnlSKhqS-YW^o#@NScez6I3x{ zv>meTLLYSK!pa+|kqQI8rWST7_)jL~mqQ}Ou*!V2U-g|ZR+pB%Z@w|HnZrV~uY*w?_gMhSp+4fY?hMmdNXYD(iruAlj0&qga8nQ1=c#y* zgYc@oWp>=|LQ+s})zQ5kv*UF?QMJ2|FN1CzjX$x&TwGJ!4VjOiZxVDVz#r28{^WRn z{o1SYRs*^Nt9(ZX`wad=44v--X~h#aROW$yKE=n-VWRfhI&wn|_X6(` z_WPK(bt4Q8gxJ=b%BW_nNj&h;H;2z`{vi`~)tCBk(zGYBp?f;(Ua+^@+rKm53ld9S zPP#A^Wv7>F7c36IAp7(%S716|mr9fnL?n&Q*?OcmX7>@shP*98yVXmJ{1{z!s;@_D zt0}M~j-0t@?)wY>a9PxzCVtBiTKiS1<;-&hv5CHiv=8d$IOnl?aI_>zR3eW}l*}`T zd7%jWK1w(iqAjU37u~dz-4@O^=PWhD7_yL+z1;-hnPx|je;QFR?I_x6McEg|;`Zuf z_}_7>V@hb=%%^H&>8W{N&Ud5bKD%p(B6#&l@nN^wOdQizb`@g}g1c|qGqGr^c>a1w z|5;G!BbS8(8#mlqM+re6&;L0Ba$evPxRGW!koG@-z@*c+8&^U^7Q+0jgUtgB$)Bh)OGD5oa(ju zL&w{}@q-4qVXtvRtXul%gWH0DxXe$&?MN>z2jh1!ElU%a2;fz@xaTyfs`lnr<` zLv5teGAw`KJIh))Wg8JzoRNMyP>X1rhr)=#Y8O6Nf7>}xLS8!@+&6k0h#H>Nn{`&~ z<h^0MI*wtWWT)UGMw#$-to|sCF?yXL$;_=8T>RsAI7ks*W{$R-UI&M5a3{Gda?9J z3PeWSws3vp1$(`F*+<1X7B6hG<6u)lqr|?N&1Up;Si*MeoRFeRNGZa1=`C?4ZaPvJ zuHL9EQ^d$jd1pu9n6iBgWPMtJyxmfJGQf{a*eag-%E@KZ$^*2_&F#h|LL)2_l*QS9(#5T>)&wtE8a=@FF+vG8N zk>*kU^97;}tRP6EGf5HKhlr6@^Nb7N1`_>QnnYF9-8tncspx59kcfE)TtFun#cCjn zEU2;}6Xu~xx+Bv+O;tKLcuo?~kQbcPghcWdz4-^H!wQOhQukRZRMRk>kfMa~V;A;p zSqpR3D87(4X}j4Awfr<~7h4dgK)pzpZf{bn z^yt`yH4+85n%*$3rL0fWi>l^4|J{Qess(a2+0W-O>gl%xIaVi`l9N3Nq}{$Q?o$#6 zP(6};On20~O*x}!V+=9YO)zz4yeTv@_04tEzA@Muc((5aTR+rHpa6@RymHX{a%Ss{ z+ZVey@TSCpCZq6G3WNWPfd3Z(|HlaUnQ37#)!hnd5VH}%lQbK+^qVrFox87bV{eTd zMjY@0wT+?ndYzV$vST&K{gWpow&Zbq;%=a$(B%@MLh@v!P|L4U zgM9JBN_Gb)g+}3@K$8-*b+GGuC&@6v)Fomd?4){kVQ)620*%U<8saNfLM+ndN~1z> zV$;~rU}Fc&M@|;i!@q(ZqbHdoB(EYYOs>u5jd5A-M`}}pr;g+_B5o2kj-|Pa zF8qc!e5d+kUV>;ih=57(*r24g=6@)>+c%LfGLw_-Bbm7r_`az+tag}5rqG&jrg(-W~CJFkaxZTf@_Ofx@ zzxqF#<4|HKKBpc&B9R1r8t{!k_=WNfzbR?aogs939=bT|!c4N>91ai-wsc4|JdG9y zGpB1A4i1ueuSS{R3h}0^YLpx`pB;Ok2-R5 zZzHya))4+|xc0QJ*&1>3;@0$RcgE3M_rt55cZ9<51j!pV&i`8js3v%e$CG{I{X+yj zruhC$iN%UA-Y%u_?FQq!rBg;{`8h`ZCg^bG&OC=733*%4cUW`DPGqp|OgNy?)-Lky zuY7>yw$@M~Jl&X?9MI2RqOdsWZwzFd6{P)UF5-=GVh z;$}}BvAUMs#V{T@TweGxI7dhuIzFqotm&oQreos6)^Nt1G4l8ce%&u1F<%WFM9t;W zBAEtq#1FS}e7Gq{9nzJ-0@1fhx^+w)&5)h+@I@?kv+h4xs>`xqTMB()kR)QH0W6ODL=b|ea)CmcTzPItT=KH66{L4@p}bW9=F z=+(cM#QUgiq$M^X08=_kUPU7sf!8j#4rN7NO0#TX0-;8=ySO&T7v$C}*`++cHZu0; zRv+{Je*j9;z>+TGv1i76Qc^1lu^>XXp&w}t;MzI_nTpY_m?O?J|UF!?x>j)zIZZ*}uTg|S?56^~@P4iEAwq#7&c^D#OmVAeT^&ib{UcAER@k$$X; zQdR$NNz=G^;6|aY!VuP>0e2>_I^ymyjmC*~Oj(aU>lb7XxoNc&mR~HbdffiYw#m3DLJ)nb-vczmSGI=PaP=yOJ4mrW01pSsP02=(ym z!R+#8VFsL>Puje-hBZZ0gY`?oFt44R6Z--pJ~w8q7te$W<+z`WB)mKtrOR>%f~{*2 z8>hh;3|%NPQq8-xDbWw`*n5*Ni7GB0zr7D?q`b1s^a4*X%Jk>EYA*r$va{t*S$Wk8 zL^lqaL9$a?PVadKA#e`-ocbsFKC1awpXsVmMxs^Fnz9Tb*6tD1sa`;k~@OqRo@ub(|hVwu)j^O#EQmIetE!ma(-|!O<`ZRqJb<$^dia$W5ARK;F@n)=G zXY|L|OhQ88G?ay6&;=(qqYF;O$NJ7x1?PPHYJC`UButfql;CF9^Z@N$9e`rgvKY7- zzkY{r^gSjplQ4S;+v7}YOOB)q;im)xJ8Tb}^>Fe{+E{o<&QW1zc~g`vO5=ii`UUW? zZp)~%d!YRLs1P5Gsp1zs3gc8)u&mU&?P*XcG+Tr-__K7L+$}7WQfV_Ngi(tq_9feK zK+m&sYg9Dt?NYYIX6$uOy3OW4i<~fWv+Cf(7LSO2Cy{IK;1#Y8C_5@I{l+TY*=I|v zB849$N`$Qn3)Wezrk#N{(Sj^ujO*o{#sa4oD_O8zmLim4B{5HQWLd}YpB(b z4G-q~15C`KQcuBSO|^7AHPTM2RneHT?`cv7UxhiJ{_{;Q;kGe05x5xg&K3|_>$pD_a&U>aXaI13$(JL50d8Z5nu7>Swu zA*$V;mYnn2)kI5c`a29y*`L60#8U8YzlVb^NVbZO*AIlUcC6{g-vYStoB)oYa(>HrRpU$_+Fu$?E^-+?mgq9i+l>lZ?b zT6(Rs*ytr2RlqzPAC<(}aFaO~EuqFiP9Nk%5YV?9#t-?A=4jtCuRhpfZRc5{uXo+q z=LI8vUYPpMT}NAmAiT1T|Lra-gEjft1a;1k`{Oe~KvJy%Wz~FR@vzsl)Hj`G)zsap zD0(^YuCzHguv&0Ryn%gl!eek+ywQej&`(Qef(ql7EcAYQoG}tAUY=Ns0uhUO05V)*ND z@*NLrHqhR{%JlU-nMJbBbn#Q$0gDOt;1glG|M6dhX@zoq#PRvcMk<`}n-dBYPlDbf zY2&o+<&J4^>4Q557tWSxa)1M;mS}X$!JFe6+N_0AI?erp9CdjDGuyvnelpc04y2u#n8-PU5wo6P&9?ZpnONA+t}Ucy z&nD(V>H%M8avRC7jdV$uW8n|L5W6kw7|(e8$j>_ZLqe`6y!1fWM}{tJ3t7HmzB894QuSOpNj=&WDT3e5Or0)3wFwasb4%9_M@6)K z&l3J-@<{!8U7lZ%P!XZsO|ejU04NSjBEBESP4Ff6+T}!&pxTCxBG{W z{I$5gyC-P##k--2l=5r77AsRg@o4?Q7zqe%7Y9-kbSnK|KDcKK;nZqb@o$i(QzUtW z4FlkIku@T67|OO;)}XWaHSwT$i->~}#O|Bld^q?M%%`d*s2x9BKP zZo$OD?q27J1NAg#Nd(Fn?4I|PbI>nwdR&!F6YOHC^L#n$QG{zQGnjL8QL{~TyS%sy zMT%4c%BbJPXL6?WNg|O1-c<>qUm^=RW`+5)eH2jAI{T^M6-_natW57V(D?*MKT4n;I#vjkQ1Y~X{0hj4% zF}qYRzy8zJX(%d$`X$XgPvDafqM65Qw_;|~(JO*m8-*q1ir0~W4cd`@#KX3_GEp5t z5?rPAGz%$L?%(5dRFgw~R^|tdxXDGF>^=J2drvtC0;nBNt)$2d+>6A}c}i_~ef`fu zywIKq{Tp+H@09h2i{+Dn7?p7~8D%gZ+<(bq<1f|tL;Qy~w3}O7WX))3Ej+(psj!1- zrlt&tNKU|u?sySN{!ByuYY@P5bL5@7&Uld^k~iLzJaP7WDAI|JZrsHHT>hmAC?xw& zC!c!IBNTzL7K;wAXR3vVTe1i(oYdqoy3H0Zw{@>?*4UcFaMCNHwib2efs0(Ync=2q zwM72#(Cn=nv2ablw^j({)fdng^E-(uP|5UD8@CzqpKlZ^=HH}?5{kmM7vLAoAatc; zwH5KZJkkdhh8C1p5+HZgC}LE+Xu}KIn7|*#?;j-8^-VaZ5jOW{JA#*;g5p`(xTiDd zKkPnW*IU@QEsE%-JWbaZU2+aF3<-bfklBU}TCC{E-~c1suP&!}=v`e&X_xF{wro+L zcgxt?1af+ArOGprbI<(>!E99@GkN&7?#q=uz{(bMN@|0qqxcTr07b2;i>k6W8Za(r zOGe?77{mF3SVV_<+hIDRNdbE)(lSDJU|Bf|swOh*8)pQ6AizER8M>1xnN1+Qcqhg$ z&ak{6PD5v75^-mAcvoOH6*!9Hkzpt)*#Ip_vNoGk)^|nj*9+w7+7R(=j4q>aw<4Wc z=nBx)kd4$ER29&>bnknJ`n4)pOczJMPJ! z0)p$AgO&S=`T1(PYN?P}4cSJ%&R?iNexQp^N$*`-AbTP7WfZIW#P4d}}S2|=#O7ke0mzh*aEWQE)y!|#~iGCKXe zpzrFFL$pk!^d8pUI(IfGO<%TTQHsrDXLDNnMC6*d0wT9m7x6Ft7V=_OlTqkuj{x>p z;1kpB_NxE04RdYk)Y!laqUU=rfZJ$T5)`7`QV?5(Ltg_xlECcjtEa{J!@6Brx);>b zl?P)xrifEIfWi;~!Hgrq*7bz~i3BH#^2_mOIb$vnOz3yqef|S?NrX2~aMzcrlIGhJ zJ57YYnbrjk0gMXNJsZ;3!GV3+U0eN7l{dNPN>2^D{M%{F_n#@Jh)M2G9pb6tlT&F# zzc){OFWO&LCDH1cNMGR@X9VA+vt>EiQ|#sD{Y6sIh0eE(T5g#Bhn{L{CgdEL#dtrL zC>~e(BtwcN6QdM$0h>v5cu{@BvleO1d{z*-w8N(k$wHP$AXwvfT1)EL-?E&6nLdTq zFA@*HmwLR__b301zkRRgd(MeG6hCvppG6OwFv=2NKQVx_rQX$Z3q-DFDcOMHtbuC2 zb}=nSGqv$BlXjj(ahhid7ECVPglKaK;z#;LgZZ+OisWYuKBPX7xpErFk*@EYkKqg2 ze61oYkPXBN#&}jK`c6OUoF{pGlCOmyvi0VbqIH)+GaMDJ>Eg{$20?GwP~=nbph7n3wT-iS@IWTjG!q<-}5nJdNKFs75SDJ`2N60FM#00h+c!NU0ufy*_DlHj73t z5%X`Hqe$xxtHUL9%+{FK#XTYqf1a`&Lh=``4pOX3cy239FO^N zfStakz4XYa-?AppcGY?%Pj@WYmLvxBlKhq06UyFTy`Dj|YO2D`3uG#B$$f7PEjp~U zN;XAx*Xx;j?A}%@n)?=Uw67Bf^MPlLUonDdnT0whr^OXyCbtVRp^N&tL4I{~Dg4l+ zvxK9}?_3)Y$>n?i!054VsQ<#MMZ=Q@luen-sz=N_VC}l?`zNJtA`krH?K@>?REBq0S+(}^2UlFWDqHi30Pa~uu05d$T+-JrcJV1?aXOg(}Rs zl`@li5%>|PHxJjZT#h6)u5#ukqU%dvk;$HYi|x;L7naNA&)c1zj7(iIm+BYA&tK7r zwW0zwzaX`x0|CVQVi4}J(N#ScVIBUXBSyY%CN{!aH)SJ(GEwpFU}-yF{d#w05hL=m zqA}!Sf^U&%EPmu~34)ZMEMWZ|Z{ zf+Da%zhehlo-wY?=x^Nensm)O!dR`~B96^wloNE6>dRY#u#pQB(ftm&2{0{aPw);3 zLS~XJegtuFdsZ#-4}Yw<2z1ya*ZublDU*Ut>&i)(l$<$AW-E7gWuf>Kh>nR@=~Jgg zYVeI|2kH%1E@)ScwTRMO*HTWJ!AcdT*o-xoiH_PF%JHNE29RfRx{{W~Mn)HwZeR53 z{~74suQ)4?@;WN79bIYU3yi%hNhnxTu7in4w>kOLA9 z^_cPfyxl`BO^Jaqzdl`|Ez%y3HTE#{dbqX?j$5k&zQxN?z*CZw+vAZV-WEk=-9oI^ zi>;EFv9pBIbUMsM{{@)yaWwa#nUxs`jEZa5y%dJ~ZYpxpbwF;r5KM9NBrtI6bS49Z z{7GcMaXGAxDfXDD;60Li!JF~fHPwUU&ynr@B*@3ChF52>+Zzj(2PL6C2Mor0xpcaX zJz8ihH2PY@>!))WZIW^vV%K*vW$Xw?vcF2|dP9n=qCP9;7B^IZhW=jxJ&T%Ztkc=ADNzA zsx*6uOG(O5$(&<*ti|J7dW)DtZjKZ4%;`A)POZf?A4Jh3X-N5M*8W<2T>+@m+RM zso4=f_o0cfhnM$+auk~mI=kVgHZ;l-+V`UB8DLApLi~fqxxCu82ZpTHwuvkJ zMaL0c$(fK#3^%@^>W3#TVHR`5ZG3y0Clb5K47#1K#yLmQyhW_55~ZZn&H*`)Kcz#xCRQCFdlucHx%dY1wZPf=tL$KK^-_TTkBlg%SX#-AMe8 zDRJaA`0SE_!0FPPn@x{0rimZQd9k+}88MLx`S?6fu6=l1Y@h3fs<=&*q;z=urTS=C zK%}u|(8k5e&Y-zSmoYb|zD$^cY}p6(t?!f9J6m?2>Tc-Xy34Rp*Ug6P;_=3oS~ z%u;Q7%I5MiGqZ{d!-pEl{0|+1NTm+haNN1M^6$Gh!|V@!B;}D{h3pn(C{xBk%}#IR zO1TK6*^j5|!U4^zB>Fw$Ab?>qDPT1M^Jx#~^C&2cPdIB_0;KSVNk9r$##HLTSD_Z& zz)jE%*Gj)7d9uVMl=+HdJ8%e}9%lwaY;_kEvV>UsLHx;mMC@f3lzq5Iv&y8{w)@Z#?E z$bXT?tyF)?<3bugVVY6(e@Vg`2i>|)$^m~$WioLwW}oXXZ}=w;=N0{LOx0{9*as^Bb{)>T@3m+vEip|GPIJDHTEO0j?I58}) z3~@%Q(7?0uCeHM#BsO=kytmWFVcmtD#HF#V$&{e5iF)nW6D|+WjJvd;&5ukcPLykI zL)z_SO#T-IEgtk{E$oT_$8EEJI%wS_Y2C(F)`01pzGC)%N-d}qrB@+6yelt`_?uuN zPMGYZCo678{Kdb+IPo{#IN(js1Ummj@!l19H8oPMb}r|M+d{D&z2T^r|!8rbRwlE=7j zz{QM`99y%o-F!wvWl#jR$l|ML^ohwPPlBQ~Vi{{yBOjvrhl~uf zK5Vk45;70o*YhtM&7#Sc2dfA3wZq@0ZZ6N~v6zg&MzJl<$ZNrwqf-$TiT@#W`2x6Mt;TiS4huyA5^}YIPTFF^l19VciDe9QgSuo770l zz$Fvs?0FY@_UtE2YE##{%dGmgZHHfzsU_`V*H`P4*F`ul(sYs9Jq*h6rbk1>eD34Z{2K;_cLbZ46halLc ze2%NUKU&GA!WwUqG&=coFm>87tCT*F4xGxo74O@5Y3xJVE!8F_1FP%~BdC2FS9Isf zXuW-CnGh!{^D*Drcrxc3Y`W9=5ZVYqn-rEs?8_&q}IoEx+VFS zRga(VCYV$<=Zq#wk?;b+las#o#HsNw*`FGFDeA^*xQuB(cE3~CcEUYt6MjgdL|p=P z2+pPgOZ0Zk#7FPiJV}Wb={;89-U46uTu_QI1&b)P=+se1|88_^!5Um>o)Nj!lfI}_ zA{$}3*734@W4yItj?m zLJCa$`Rn$L_lRPSglt!uro*Wg-e^WHi@NW8q5zxYdq%ULx=%RZ(Ry~zKFHmgD!x8n_+?xj`!7VyZLb@!Ht zcyvx*=Ox|L<#!iwxI;b}HqA-#(_&c7eI; zh0-~Nl>BWL;lGfbd$~ThM~0`;bnAxA&t^Bg46A9F67?ijVTmmSHXl37dKJH@X%pJ( zv;J34-$9e2BLwPjbgdS-#g6)O&a!wuZ-4?=C;(W1fb*oq3F7!&Q;TDT{dSIuAJ0r( zTYW}1z5Y^?(IYRkcvPK{&UNZ!DTD2NG^^l4v6pZ*x!@0~FW+zs*VWLZvD5?b&529v zzAIr#Blpmqud6Eze&qzM(zwET6WE`YFdmz$)SiInkY`uE9 z2W8d!Z|P-BLFnbp3rcnGlI9P_{}G(V#2CJpq^&-OF7u(-e@`ex!`4!J7AZxIWjne$ z*}p)Oo)D;<^YCfczySXZ)mxzJ%Trh$e@@Xs6YI$UjQXTpMM3=OD}yJh-k2t_G}69%^Fr!Z2HQA5*4M*x@spn| zrheG^IKj0ez3X@*QK}PLKen)$lLlOFZ8tSxuEOsfZ4ZBRv~f7a=7}eY0qYvDhVUkw zZOeCWJKZrO(yrm9v!+wYKhPp+8sVTN>nKBQt1)2z7ZTr41?oJxD3UIFa*^`;bD2FhRFQI1$)e-S7>YM&OE5M83i$Yg1gC4XbSB(3HY$XeKc0w~r|t-}85eyvq znGOcAFmP`I@uNFB6D-U3R7zi&HI?4$T$XBCYp7jyF2hIU++&75Z}~Yj0lG(o!Q{%x zle@H4z=iwQ^%fFV}$@P%l|Q*S||Fc=aU(OuYN7&dFa}V3Nc7J*3pGRNHysT zpl1qYqD}+z4udN>1yr0@uF3~3%~hGND|wBbU_IaPN$MmzOSBa(DV?!lmqJAFWhao7 z6XK-N{+v`HO%=al&V4z}>Sa|@+Qf8!nk9bZMS#vdzl+RDih{^-@~-07nqb7URdH*R+DD=7!&A9Oi{-a*?F%R^?_>z|&W zHQ+4C_b)3pp#^K(qJHO8s1UDOMw^aDYOOebgZD{HMbGVDVk$+=PF2;lVmdaX96DD( z2>^x9360&?xbJ=C?ww+GUzY7mi#yf$i@Zi^^Y}?DA8FLB1O|#d@$jX3gICv(QdzlV&8dxsHV(c+LsK>QTvzU6_ zYb0#5dCxZ%c~~}R7+|_=M1NiJ;GL(M6jlh!W$wT&BZz#^;TRxOvOoC5av{aK*jUdB zEJTT7g$OLq7j%VOxq7lBmjswrMs{Cq4i_QLuY?I-R*l_PX%)WEauEF6LE{{cM%g#Z zY=g9-pHTq4-?B_^ws)ot(CdUT(Q;?3ZgB%&0-LSJk}S~oODd0f;gmE$LNlWC)*SZw zTF2tWUDe>}3GAgFzfUW{@fr-5%+TXNF!#@u3xLK#M@{^pJ@RwHxR(mQv$rbM^u)yF zp7gc4+^-scO=w4GnLoUHm&|*G%B4)zdnT-@sLAXD{t?qVWoK?M#QmO7ZDZYumcROM zT0RXq?@|A$uOb2&0IX>Ab9ty?U)lM3)bo7LPM+d~0IDZ9U)9X4Pt|IhEccrc4$Yqg zxN&t9niz^0H@V{LX*57HW5=4LcVn`mZrtz!m-E4LWa#a&|ZE=ZeR z_be>uWC0uQotqmp(+ySAn|+s`Jh^?c#?)U-^^qVEROY9akEY4F$EfL{d=!)6%BG-- zzxb^*e?e$Rf1Wl1QT?k8F>OCoXwv?=Ung`f@oR`*z|{D)G%5h9(2EXaoVg^$f5Zm< zKZTunJXG!9$1R~Oja|ej${K1yXo$j8_FcA;rjQxV!J)?|Gj8yk6(bnRAXg-|KsQuFvOvU}1Q)$#BKFf7rFv3#c^C6nuM& zOO0Gft$Kq{^uZk+fBQMx4ywF#eZ10jN%@}^6Trc3hCtkr5v?qLPeTBZoa}i>5KfE4m^W45!H&tNIy2!R)_bi2pfs)oyorVbu+nl5 ziVqIJzcjU0;LWSXA>n4vmdvWwz`nJ(vB0=#2PO^BiHo&%ecgXrM@U_;#^7aMCflK* zu?J85J`Tl@CXG@Gz9}c1FQwCP4okOwbBpS37P8a>qfV`z9k+`X5YFPzTfu%UP!6y`Fvr_P9?4V5;X6Bf8{U9#rCkAZ zM&uVB!n66B@`9(+a&}!KKRfCf^oQNN+6$^tHoMIK!>*$7-0ZFr=x>*b-P5X-LgxBY zo2Ug*pNH%q>8qqJmtk=~7g&DYcueN3PcuE3&z~%j0gUYgSS9wn57tV0QdV~{+bxEnx{U^j4&k6Tg_t{mX$_Yq$xe=@q|jc4#`MB^ zJT!tidMB9LT+XqKk3JFN=!_dS0?dknKn##1>;EeT2o)}9LyEIBz=e4SFuw9d_vq)Y znKx|vFBXdWkaNz_)-AYMGNnQ9zLj_f%C}~7N!N>u)Lf+CfEIdIU7czh$QbcAide4T zZQJy*?<2fUv(SP%PV21I_X1kz7G8vO5oI)0xCIvcYt6{A`!}bwQlGSad^&0sE+dig ztCN-J!D2iYgG*FJ2{BPzy1^u&y=FXDd67a8y7BGP|L)Sh_Z*1ci7meUFD~utdnA|k z%FkshXa7&|yHfQ-cZaL9*88w++@nx&uAPsEVL*=wVw{~gi>(snR7!xUfN3m@nIRqe z$bxi@pG5F$L=in`nIEOo82`J5h_9j*7~_4)pr(1ea&G+SOCoJiMKDK#1^!`Tmo zu(KAj$s(@Ez}~eSFWD$y#q zslU<&-b60sArh0MhfMd8Ut(rM_CQZ8FfKQivy3;fi)0|#R9eO4o~zDAw8`&mCJBRl zL+V<9>B#dX+=Ch6E=t$PUla#aJlOiq<<`$o@7t~|m@_8YX~f5JPr8|q*x0k}KKaw) zlj4s{p!Bb0(O2I@&cJP`BT4v(=^IBCC}>G;6Pl`dvTGO(u1uHZFzBch#Oi5#?{oUA zMDhff&?FU9`${$qfOt^aXNUDLXp}!L8o++(*YdqI@rZ`e_9q$WGiZtk%BdwBGNUQLOvKhbHU?bZL0ypyF6t66gl zm;}?$LvW7=cpykxJulrHg1_Tybvk9?!FUgQFW7)ZjiG5RKh5P)A-N+a_IR~*prd%Jub(3dwV#iE zEZRnitmR!zrZDwcFZbI$fi zpQ#2NyF^|ZZxhg}_2{p|uY5RbnD8K6ZJ*(Qw2)?}wekp&yaRA|Qo#DxsS?SeI+jqSMG)is9$_pX3e;QRCk`w z6Eyf}-+>ptnm-5fB$ja02cI*FiDNlWz6!au(Hs}CGqc@Mmic~|=QFFJrG1@1hjtXy z4~e%c+1cVu*QrSvt}^-J7&3CYOFA(;0v#pDtP1!!v4p;BvW*`n{US>q(dX{NUrV`ti>sUd7L3MP0-oP`aRTgYw5brGKhov{JH8&ZnR)OJ2X6Hj z*N%E-g5%w9Tu(o3p@Ox209&F)dqM|)8ypzq@>_T7)U{4lXM#FbS?FxaC!G^bZMM9+ z4tmuQbQP|}fWbv^^L6{ks3C9Ej)`TTPs7Rx%f;*+b8A$!FHS$N0rHb7YlE-;Os=Pr zQ{twGcgc=sfxFbo@AZ<0v(i)mIIN>SayZmhz4f%!>5C|cW!)L%h17s1v)z*m@qbN( zLIG`HP@`-xc!<{bo61SZlQWVZ1OuYl!Sb-gF-ru;V-o?-65R4%f%6Z;4dlCb<*tm4 zT`7ejX`!VvI;>13$7YHQz%+8p7l(Tpo$_JB4f^W={o?Bv;zK3iLCjqj{gvE5lo;fd zHH{q|VzJ(ecLFb~dW44K((lhkhDQ$2inQ@ZcRq7Y>-^*1b>gOVEt)4}ovdHpbt^K@ z|3sf`Dm|bJwcZkK{pP34+PPS-&Y(HzYpQh%%*U0(ohJ^qYv&SPhZse79v3M#nTUb? zTTjUjU*9&)0S1{kUx6pKuPYG_c~z}evFZy5xUz{>?k8wd2OGRLnS6!W@2E;KWyJGkUt&UFTh*2NVjj=kW%jj~V001z!4 z=ACav4hf=_2vC25z)FK{a-HCIF%1b@(>NH^N7$**yWUBYO61yA32R`g-kGrQqT2&s zZ1aW~`>zx~03Uhl@0bL?Vul+mpc)cp64nzfU1rpi*eG&?8WU7Xl4Pf1!!_iKpK_${ zC;xLY0h})InNl8x8hkL6Jpz7odsa%}^mCw|17HWPhf{dC+kQ}x((i~n?<}jL=p9a@ z<9^KPtHyuVYuBL`*B7H;P2iVO8ICwx_P&$c40y;=GC7R)u@F`J-|`;#me&bZ9#xFU zJg^Th!=rFfc{Bw+ujIxWBM>U0T(6i0?6X&W^QWn?a#<*foA?<)RQJ+am_wkw5~pN- z7sfTpB>PChT4dEn1d;2VMl0o-hg^bZeAQZSZ%fT*?fK_jkzO;p1^Kn_+yjstFP#ra zNvx;BrMYSMj?`B;0sS zFuJaW4L~Ou?IWxSIxyrDP0$laaSx}5DtUOzHO?=y^m2JYfcOG)&~ws}entE=bCT7$ z=#rYt?lU1eR^i}WaqU8Z0rKPflqR^`l!q|k(Zo+khOK+ubx;hXEPh&3dhXVaKhK_5 zEWuW;iN*%L+&b5&xM}Dl-pY8w8~S%KsSYAxoEeE0RatjS6)vupzw^Mi4zR4J9^a9vEO zGsL1|=&T;B!-Hc|XANCOT4+&_Am}oQeN;)!5I#Ng%dGfD89Z`xzBJfQ5Uq?0g3AeUS9@IhE|>w~}OV)8>HvkoV#COPN{LT#vk8 zt2Z)j@{a(~lW*kv*4-rOL6sffa^(OAYdJ-0AsgF9gwSQe2wH&X@4yh*TSHt#%TNt1(?*1p$1*$&WoXj%(3D- zcQ5QJ#PkYUg9UjMs?vZCI$TX&{X=JmqECeM2>uCx|CpLx$`!gYuDe(vVX}YRkFG^k zURe>tw{_d=^mg9nvS?KtpkI=2?(iG$tPXR5QosdvzxGoCt z$$I=Gfzpq+2F3?10L^~%hk|tHo!byiu28i+0-PzrVDKCekd-_eW}(>Fp}Ancc191J z%LV{ozGVXd7!U|yD)X?cRj`u12B#u~Q22#>5x;tCwV54R+A8Kzk+(poe&f<5a*v*K zT2oU&Cy_LPGej(sedjw!v3{YylrY}sxYF)>cfp<-T!xEu)CFu&YJe?D)I%N!%*L!8 zEi#ZVi4r-oMksMF`zOoUUiq(+KVL}Vgk4zs|M2{i%LBzJSShuf5=6EJK+gfbJ})q= zG0GhyJ>s|)s`}>jgj5{06DiB8;CT5#UeEFuCDRNU65yFEh+SOUYPR?{idoz^hcctc z&442k_wYk5d(L7ZTKmy)4^n0o##7c6!_jl_B86&KbNSP0;&tq_AS1DeI66n%PR*pX zi2%0k-ZNP@3`AaRb)vJ?W}XEv*Z1a+PPd6tY;c0IY-s0=Iw-*C*soU) zC=bBofdMQRHt;f`m;%bDO+Q@6&hS8dvdDDe(V_H-k2t&!J`FL&9w2#0bHLqd5+>n8)4e;ua%TPUO&4#d!TjvD`IHe+m+wqABkj zoNs5r+GI!s>cQZx77EF%7%V;lk~d43R$%h9**@|sc6SSR>J07Anld(@sT0nyR>Qu_ zPhkc@Fj;M*AKsf3%f|p*H1HyY%3g7T%cCKt?y8k0=-`j0laL`{!mVH11jZ{=3)Zbo z21^05#asw*jiv?Hew&@KV*;teNz-jz?UZ2y0k!l8DBW^9Rj~0!uD>Ft|27Lg;_|N} z*?vvL_xnuig>$EG@^@kLoJ?zdbt0stXU1YVLJO_W zCv!h-*}a>}{Q3SZv`DX6-2%p&B;T>R%A72KsxXP5VK54m2trhI`mBmx(#zV{ zInu6zS{==2l?XBO^i7UsOK?Fk{?ekyEXECjxn| ze`kRpJim|8Q}?3d(XG1>vcoX%zs<(_g-QWYTElLe@&5AL%%^F!{2#PFiop zRz~d(ix56>b@e=g)qGNk>2`{de6Q_WxRCIF*6yQFR#bxy#Qy{EQ~~2n-V>tkL{`UY z&0Rmmuj2DpeT)jObl<7A@des_b`d1V25nwoq~e9M<^f>hHSU>co8g(*{m}-YwofiI z-mkS=3Wl~O+8MFVW{YqX8E6K**_pPc`QNK@m~X8Hg&Kle5qX4L!dd6!IWdLU*Nlkc zGiH(n$H6or(h^BfuCPB&?kP`30z;2(u1 zR+FQfD9dIbldYlRvSLo87bRrF5U656yei7F$Z+uFv&!-!9(3wD{QY)By0oUJmuQ{- zU}FV=;Y7LSZ1uxnRdzVY10dxWlIkcKoJet_HxrwC@n~W6^hFyQekJ5|pV<4XQj zka1?kZLfD%g`ld(`_Jln6>AAWt9jnwML-$NI@O($<9KJ{W`C%l?Zl4-L0J7Mr!-?21u}Dy5k;D zu}!eeZ*3?R;L}9xDghYu?{zNJxF-U5o>7it>+~T~$v2ua{;7P)^J*yJ6~TT02(a@l_L<@JIZo3wOYJ9t9BNNUnvpIZ184_1fah;Vh@r1saB z^4y@`7jq3dxmVlsiow+%)C~5)FovY6v>3pvw$J%t@r@7cp&Ec@j$@T1u-i81-!`X5 z*u0~!^hDZq+7k7};*;b~0?h1x(q(|(>8OIVD1hr(THoGWk=iwDyIPzQf69sA=(J+o zn#EcLV}QPlry2xM(Oe*&QuTxz|DO({_ui&T9ig&XSsUK?V&dy)5>MGnr6uw&*J)SR z4O5d0C2t!+(VG{Y3fFU3G4!F~;z`0^Zy$VT zlJGjGSF&$3BUtfc03n5Fp1KQfb~InA&8`q*1q&GG=||Hzpy6L2H1f*;LpyQht{w?} zDZ2kUk>FaSr)>&iD|Z|7sH6U!z%}z@JhB~OedrN<`}Lfq^UV}Y43>cn?*zZ0AOM2< zpX5w(`QSQaEYTvqHz~=NXHUjQf0o%dBkQfeAN31lR&xxOEgYHTdZp%bVXN280=Ana z^M=FH$n=5rl?&BI)^08Qe_`>YwGkkoEIR+Kv^%~Pb0k^b?3|sA#qp8cs#eTueeM2Q zRw=0&M&6mX$~YF!Y0ZBc@63#c7`f!9BKSXd@Voc{RoLU+XN*d^;RK${8T?=LBS%Bk z&gkb&o-U3d6^w6h1+IPUz|;DW zIZ;96kdsD>Qv^q=09&hp0GpEni<1IR%gvP3v%OR9*{MuRTKWHZyIbuBt)Ci`cU_&% z1T+i^Y)o{%281-<3TpPAUTzw5v;RY=>1rvxmPl96#kYc9hX!6V^nB|ad#(S+)}?8C zr_H+lT3B#So$T=?$(w3-{rbQ4R<@nsf$}$hwSO)A$8&`(j+wQf=Jwhb0`CvhR5DCf z^OgI)KQemrUFPH+UynC$Y~QHG%DbTVh-Skz{enNU)cV_hPu~{TD7TPZl>0&K>iuE| z7AYn$7)Jrb9GE&SfQW4q&G*@N|4cHI`VakFa5-C!ov&XD)J(qp$rJJ*9e z-sHv}#g*T7Cv048d1v~BEAzM5FztAse#q78WWC^BUCzQ U&wLp6h6BX&boFyt=akR{0G%$)mH+?% diff --git a/website/static/api/assets/images/widgets@2x.png b/website/static/api/assets/images/widgets@2x.png deleted file mode 100644 index 4bbbd57272f3b28f47527d4951ad10f950b8ad43..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 855 zcmeAS@N?(olHy`uVBq!ia0y~yU}^xe12~w0Jcmn z@(X6T|9^jgLcx21{)7exgY)a>N6m2F0<`Rqr;B4q1>>88jUdw-7W`c)zLE*mq8W2H z-<&Jl_Hco5BuC5n@AbF5GD82~-e8-v=#zCyUX0F-o}8pPfAv`!GN$ff+TL<~@kgt} z62eO?_|&+>xBmM$@p|z`tIKEdpPf8%qI>4r7@jn<=eta*{3~?g(zz{Ke9zc-G^gr? z-7foa?LcS!hmbwzru}ICvbWLlW8;+l-}!^=c32!^nV`+`C*;0-*Y%l94pC;Cb3GXz zzSf%a!{gVr{Y_lVuUj+a)*Ca+!-Hu%xmP&&X-2CuANY8^i{D7Kg6qzP zXz_ps9+lN8ESH{K4`yu&b~I>N9xGlE&;2u*b?+Go!AhN?m-bxlLvtC#MzDF2kFzfHJ1W7ybqdefSqVhbOykd*Yi%EDuhs z4wF{ft^bv2+DDnKb8gj1FuvcV`M}luS>lO<^)8x>y1#R;a=-ZKwWTQQb)ioBbi;zh zD!f5V)8581to1LL7c9!l^PSC$NBPYif!_vAZhmL4)v4U)4UsrLYiH_9rmQDd?)(e5 z^pcH>qvBg*i0dus2r*mp4;zKvu=P#s-ti;2obl`NjjwoYd>e(oo#j_uyRb<7Pv^If zzZ|mGHmV)8^tbO%^>eqMw(@7(&3g{jEp-Najo7V75xI_ZHK*FA`elF{r5}E*d7+j_R diff --git a/website/static/api/assets/js/main.js b/website/static/api/assets/js/main.js deleted file mode 100644 index 5fe710b2..00000000 --- a/website/static/api/assets/js/main.js +++ /dev/null @@ -1 +0,0 @@ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";function x(e){return null!=e&&e===e.window}var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0>10|55296,1023&r|56320)}function oe(){T()}var e,d,b,o,i,h,f,g,w,u,l,T,C,a,E,v,s,c,y,k="sizzle"+1*new Date,m=n.document,S=0,r=0,p=ue(),x=ue(),N=ue(),A=ue(),D=function(e,t){return e===t&&(l=!0),0},j={}.hasOwnProperty,t=[],q=t.pop,L=t.push,H=t.push,O=t.slice,P=function(e,t){for(var n=0,r=e.length;n+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"�":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){for(var n=e.length,r=0;e[n++]=t[r++];);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){for((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;o--;)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){for(var n=e.split("|"),r=n.length;r--;)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)for(;n=n.nextSibling;)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){for(var n,r=a([],e.length,o),i=r.length;i--;)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&void 0!==e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if(void 0!==t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t=void 0!==e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if(void 0!==t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];for(i=t.getElementsByName(e),r=0;o=i[r++];)if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return void 0!==t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"!==e)return o;for(;n=o[i++];)1===n.nodeType&&r.push(n);return r},b.find.CLASS=d.getElementsByClassName&&function(e,t){if(void 0!==t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)for(;t=t.parentNode;)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);for(n=e;n=n.parentNode;)a.unshift(n);for(n=t;n=n.parentNode;)s.unshift(n);for(;a[r]===s[r];)r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||void 0!==e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"!=typeof e)return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this);if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){for(;(e=e[t])&&1!==e.nodeType;);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n=void 0!==e.getElementsByTagName?e.getElementsByTagName(t||"*"):void 0!==e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v)for(n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return void 0!==k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;l--;)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){for(l=(t=(t||"").match(R)||[""]).length;l--;)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){for(f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;o--;)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),i=("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,r.left):(a=parseFloat(o)||0,parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{for(t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position");)e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){for(var e=this.offsetParent;e&&"static"===k.css(e,"position");)e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0":">",'"':""","'":"'","`":"`"},P=h.invert(L);h.escape=W(L),h.unescape=W(P),h.result=function(n,r,t){h.isArray(r)||(r=[r]);var e=r.length;if(!e)return h.isFunction(t)?t.call(n):t;for(var u=0;u/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};function $(n){return"\\"+U[n]}var J=/(.)^/,U={"'":"'","\\":"\\","\r":"r","\n":"n","\u2028":"u2028","\u2029":"u2029"},V=/\\|'|\r|\n|\u2028|\u2029/g;h.template=function(i,n,r){!n&&r&&(n=r),n=h.defaults({},n,h.templateSettings);var t,e=RegExp([(n.escape||J).source,(n.interpolate||J).source,(n.evaluate||J).source].join("|")+"|$","g"),o=0,a="__p+='";i.replace(e,function(n,r,t,e,u){return a+=i.slice(o,u).replace(V,$),o=u+n.length,r?a+="'+\n((__t=("+r+"))==null?'':_.escape(__t))+\n'":t?a+="'+\n((__t=("+t+"))==null?'':__t)+\n'":e&&(a+="';\n"+e+"\n__p+='"),n}),a+="';\n",n.variable||(a="with(obj||{}){\n"+a+"}\n"),a="var __t,__p='',__j=Array.prototype.join,print=function(){__p+=__j.call(arguments,'');};\n"+a+"return __p;\n";try{t=new Function(n.variable||"obj","_",a)}catch(n){throw n.source=a,n}function u(n){return t.call(this,n,h)}var c=n.variable||"obj";return u.source="function("+c+"){\n"+a+"}",u},h.chain=function(n){var r=h(n);return r._chain=!0,r};function G(n,r){return n._chain?h(r).chain():r}h.mixin=function(t){return h.each(h.functions(t),function(n){var r=h[n]=t[n];h.prototype[n]=function(){var n=[this._wrapped];return u.apply(n,arguments),G(this,r.apply(h,n))}}),h},h.mixin(h),h.each(["pop","push","reverse","shift","sort","splice","unshift"],function(r){var t=e[r];h.prototype[r]=function(){var n=this._wrapped;return t.apply(n,arguments),"shift"!==r&&"splice"!==r||0!==n.length||delete n[0],G(this,n)}}),h.each(["concat","join","slice"],function(n){var r=e[n];h.prototype[n]=function(){return G(this,r.apply(this._wrapped,arguments))}}),h.prototype.value=function(){return this._wrapped},h.prototype.valueOf=h.prototype.toJSON=h.prototype.value,h.prototype.toString=function(){return String(this._wrapped)},"function"==typeof define&&define.amd&&define("underscore",[],function(){return h})}(),function(t){var e="object"==typeof self&&self.self===self&&self||"object"==typeof global&&global.global===global&&global;if("function"==typeof define&&define.amd)define(["underscore","jquery","exports"],function(i,n,r){e.Backbone=t(e,r,i,n)});else if("undefined"!=typeof exports){var n,i=require("underscore");try{n=require("jquery")}catch(r){}t(e,exports,i,n)}else e.Backbone=t(e,{},e._,e.jQuery||e.Zepto||e.ender||e.$)}(function(t,e,i,n){var r=t.Backbone,s=Array.prototype.slice;e.VERSION="1.4.0",e.$=n,e.noConflict=function(){return t.Backbone=r,this},e.emulateHTTP=!1,e.emulateJSON=!1;var h,a=e.Events={},o=/\s+/,u=function(t,e,n,r,s){var h,a=0;if(n&&"object"==typeof n){void 0!==r&&"context"in s&&void 0===s.context&&(s.context=r);for(h=i.keys(n);athis.length&&(r=this.length),r<0&&(r+=this.length+1);var g,m,s=[],a=[],o=[],h=[],u={},l=e.add,c=e.merge,f=e.remove,d=!1,v=this.comparator&&null==r&&!1!==e.sort,p=i.isString(this.comparator)?this.comparator:null;for(m=0;m=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){for(var t,r;47<(r=(t=this.next()).charCodeAt(0))&&r<58;);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos=this.scrollTop||0===this.scrollTop,isShown!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},Viewport}(typedoc.Events);typedoc.Viewport=Viewport,typedoc.registerService(Viewport,"viewport")}(typedoc||(typedoc={})),function(typedoc){typedoc.pointerDown="mousedown",typedoc.pointerMove="mousemove",typedoc.pointerUp="mouseup",typedoc.pointerDownPosition={x:0,y:0},typedoc.preventNextClick=!1,typedoc.isPointerDown=!1,typedoc.isPointerTouch=!1,typedoc.hasPointerMoved=!1,typedoc.isMobile=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent),typedoc.$html.addClass(typedoc.isMobile?"is-mobile":"not-mobile"),typedoc.isMobile&&"ontouchstart"in document.documentElement&&(typedoc.isPointerTouch=!0,typedoc.pointerDown="touchstart",typedoc.pointerMove="touchmove",typedoc.pointerUp="touchend"),typedoc.$document.on(typedoc.pointerDown,function(e){typedoc.isPointerDown=!0,typedoc.hasPointerMoved=!1;var t="touchstart"==typedoc.pointerDown?e.originalEvent.targetTouches[0]:e;typedoc.pointerDownPosition.y=t.pageY||0,typedoc.pointerDownPosition.x=t.pageX||0}).on(typedoc.pointerMove,function(e){if(typedoc.isPointerDown&&!typedoc.hasPointerMoved){var t="touchstart"==typedoc.pointerDown?e.originalEvent.targetTouches[0]:e,x=typedoc.pointerDownPosition.x-(t.pageX||0),y=typedoc.pointerDownPosition.y-(t.pageY||0);typedoc.hasPointerMoved=10scrollTop;)index-=1;for(;index"+match+""}),parent=row.parent||"";(parent=parent.replace(new RegExp(query,"i"),function(match){return""+match+""}))&&(name=''+parent+"."+name),$results.append('
  • '+name+"
    • ")}}}function setLoadingState(value){loadingState!=value&&($el.removeClass(SearchLoadingState[loadingState].toLowerCase()),loadingState=value,$el.addClass(SearchLoadingState[loadingState].toLowerCase()),value==SearchLoadingState.Ready&&updateResults())}function setHasFocus(value){hasFocus!=value&&(hasFocus=value,$el.toggleClass("has-focus"),value?(setQuery(""),$field.val("")):$field.val(query))}function setQuery(value){query=$.trim(value),updateResults()}function setCurrentResult(dir){var $current=$results.find(".current");if(0==$current.length)$results.find(1==dir?"li:first-child":"li:last-child").addClass("current");else{var $rel=1==dir?$current.next("li"):$current.prev("li");0<$rel.length&&($current.removeClass("current"),$rel.addClass("current"))}}function gotoCurrentResult(){var $current=$results.find(".current");0==$current.length&&($current=$results.find("li:first-child")),0<$current.length&&(window.location.href=$current.find("a").prop("href"),$field.blur())}$results.on("mousedown",function(){resultClicked=!0}).on("mouseup",function(){setHasFocus(resultClicked=!1)}),$field.on("focusin",function(){setHasFocus(!0),loadIndex()}).on("focusout",function(){resultClicked?resultClicked=!1:setTimeout(function(){return setHasFocus(!1)},100)}).on("input",function(){setQuery($.trim(($field.val()||"").toString()))}).on("keydown",function(e){13==e.keyCode||27==e.keyCode||38==e.keyCode||40==e.keyCode?(preventPress=!0,e.preventDefault(),13==e.keyCode?gotoCurrentResult():27==e.keyCode?$field.blur():38==e.keyCode?setCurrentResult(-1):40==e.keyCode&&setCurrentResult(1)):preventPress=!1}).on("keypress",function(e){preventPress&&e.preventDefault()}),$("body").on("keydown",function(e){e.altKey||e.ctrlKey||e.metaKey||!hasFocus&&47this.groups.length-1&&(index=this.groups.length-1),this.index!=index){var to=this.groups[index];if(-1 .tsd-signature");if(!($signatures.length<2)){this.$container=this.$el.siblings(".tsd-descriptions");var $descriptions=this.$container.find("> .tsd-description");this.groups=[],$signatures.each(function(index,el){_this.groups.push(new SignatureGroup($(el),$descriptions.eq(index)))})}},Signature.prototype.onClick=function(e){var _this=this;_(this.groups).forEach(function(group,index){group.$signature.is(e.currentTarget)&&_this.setIndex(index)})},Signature}(Backbone.View);typedoc.registerComponent(Signature,".tsd-signatures")}(typedoc||(typedoc={})),function(typedoc){var Toggle=function(_super){function Toggle(options){var _this=_super.call(this,options)||this;return _this.className=_this.$el.attr("data-toggle")||"",_this.$el.on(typedoc.pointerUp,function(e){return _this.onPointerUp(e)}),_this.$el.on("click",function(e){return e.preventDefault()}),typedoc.$document.on(typedoc.pointerDown,function(e){return _this.onDocumentPointerDown(e)}),typedoc.$document.on(typedoc.pointerUp,function(e){return _this.onDocumentPointerUp(e)}),_this}return __extends(Toggle,_super),Toggle.prototype.setActive=function(value){if(this.active!=value){this.active=value,typedoc.$html.toggleClass("has-"+this.className,value),this.$el.toggleClass("active",value);var transition=(this.active?"to-has-":"from-has-")+this.className;typedoc.$html.addClass(transition),setTimeout(function(){return typedoc.$html.removeClass(transition)},500)}},Toggle.prototype.onPointerUp=function(event){typedoc.hasPointerMoved||(this.setActive(!0),event.preventDefault())},Toggle.prototype.onDocumentPointerDown=function(e){if(this.active){var $path=$(e.target).parents().addBack();if($path.hasClass("col-menu"))return;if($path.hasClass("tsd-filter-group"))return;this.setActive(!1)}},Toggle.prototype.onDocumentPointerUp=function(e){var _this=this;if(!typedoc.hasPointerMoved&&this.active){var $path=$(e.target).parents().addBack();if($path.hasClass("col-menu")){var $link=$path.filter("a");if($link.length){var href=window.location.href;-1!=href.indexOf("#")&&(href=href.substr(0,href.indexOf("#"))),$link.prop("href").substr(0,href.length)==href&&setTimeout(function(){return _this.setActive(!1)},250)}}}},Toggle}(Backbone.View);typedoc.registerComponent(Toggle,"a[data-toggle]")}(typedoc||(typedoc={})),function(typedoc){typedoc.app=new typedoc.Application}(typedoc||(typedoc={})); \ No newline at end of file diff --git a/website/static/api/assets/js/search.js b/website/static/api/assets/js/search.js deleted file mode 100644 index 0b759b45..00000000 --- a/website/static/api/assets/js/search.js +++ /dev/null @@ -1,3 +0,0 @@ -var typedoc = typedoc || {}; - typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"2":"Module","4":"Enumeration","16":"Enumeration member","32":"Variable","256":"Interface","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal","4194304":"Type alias"},"rows":[{"id":0,"kind":2,"name":"Tableau","url":"modules/tableau.html","classes":"tsd-kind-module"},{"id":1,"kind":4,"name":"AnalyticsObjectType","url":"enums/tableau.analyticsobjecttype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":2,"kind":16,"name":"Cluster","url":"enums/tableau.analyticsobjecttype.html#cluster","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnalyticsObjectType"},{"id":3,"kind":16,"name":"Forecast","url":"enums/tableau.analyticsobjecttype.html#forecast","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnalyticsObjectType"},{"id":4,"kind":16,"name":"TrendLine","url":"enums/tableau.analyticsobjecttype.html#trendline","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnalyticsObjectType"},{"id":5,"kind":4,"name":"AnnotationType","url":"enums/tableau.annotationtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":6,"kind":16,"name":"Mark","url":"enums/tableau.annotationtype.html#mark","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnnotationType"},{"id":7,"kind":16,"name":"Point","url":"enums/tableau.annotationtype.html#point","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnnotationType"},{"id":8,"kind":16,"name":"Area","url":"enums/tableau.annotationtype.html#area","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.AnnotationType"},{"id":9,"kind":4,"name":"ColumnType","url":"enums/tableau.columntype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":10,"kind":16,"name":"Discrete","url":"enums/tableau.columntype.html#discrete","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ColumnType"},{"id":11,"kind":16,"name":"Continuous","url":"enums/tableau.columntype.html#continuous","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ColumnType"},{"id":12,"kind":16,"name":"Unknown","url":"enums/tableau.columntype.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ColumnType"},{"id":13,"kind":4,"name":"ClassNameKey","url":"enums/tableau.classnamekey.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":14,"kind":16,"name":"WorksheetTitle","url":"enums/tableau.classnamekey.html#worksheettitle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":15,"kind":16,"name":"Worksheet","url":"enums/tableau.classnamekey.html#worksheet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":16,"kind":16,"name":"Tooltip","url":"enums/tableau.classnamekey.html#tooltip","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":17,"kind":16,"name":"StoryTitle","url":"enums/tableau.classnamekey.html#storytitle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":18,"kind":16,"name":"DashboardTitle","url":"enums/tableau.classnamekey.html#dashboardtitle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":19,"kind":16,"name":"Pane","url":"enums/tableau.classnamekey.html#pane","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":20,"kind":16,"name":"RowDividers","url":"enums/tableau.classnamekey.html#rowdividers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":21,"kind":16,"name":"ColumnDividers","url":"enums/tableau.classnamekey.html#columndividers","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ClassNameKey"},{"id":22,"kind":4,"name":"DashboardObjectType","url":"enums/tableau.dashboardobjecttype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":23,"kind":16,"name":"Blank","url":"enums/tableau.dashboardobjecttype.html#blank","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":24,"kind":16,"name":"Worksheet","url":"enums/tableau.dashboardobjecttype.html#worksheet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":25,"kind":16,"name":"QuickFilter","url":"enums/tableau.dashboardobjecttype.html#quickfilter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":26,"kind":16,"name":"ParameterControl","url":"enums/tableau.dashboardobjecttype.html#parametercontrol","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":27,"kind":16,"name":"PageFilter","url":"enums/tableau.dashboardobjecttype.html#pagefilter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":28,"kind":16,"name":"Legend","url":"enums/tableau.dashboardobjecttype.html#legend","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":29,"kind":16,"name":"Title","url":"enums/tableau.dashboardobjecttype.html#title","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":30,"kind":16,"name":"Text","url":"enums/tableau.dashboardobjecttype.html#text","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":31,"kind":16,"name":"Image","url":"enums/tableau.dashboardobjecttype.html#image","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":32,"kind":16,"name":"WebPage","url":"enums/tableau.dashboardobjecttype.html#webpage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":33,"kind":16,"name":"Extension","url":"enums/tableau.dashboardobjecttype.html#extension","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectType"},{"id":34,"kind":4,"name":"DashboardObjectVisibilityType","url":"enums/tableau.dashboardobjectvisibilitytype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":35,"kind":16,"name":"Show","url":"enums/tableau.dashboardobjectvisibilitytype.html#show","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectVisibilityType"},{"id":36,"kind":16,"name":"Hide","url":"enums/tableau.dashboardobjectvisibilitytype.html#hide","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardObjectVisibilityType"},{"id":37,"kind":4,"name":"DataType","url":"enums/tableau.datatype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":38,"kind":16,"name":"String","url":"enums/tableau.datatype.html#string","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":39,"kind":16,"name":"Int","url":"enums/tableau.datatype.html#int","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":40,"kind":16,"name":"Float","url":"enums/tableau.datatype.html#float","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":41,"kind":16,"name":"Bool","url":"enums/tableau.datatype.html#bool","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":42,"kind":16,"name":"Date","url":"enums/tableau.datatype.html#date","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":43,"kind":16,"name":"DateTime","url":"enums/tableau.datatype.html#datetime","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":44,"kind":16,"name":"Spatial","url":"enums/tableau.datatype.html#spatial","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":45,"kind":16,"name":"Unknown","url":"enums/tableau.datatype.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DataType"},{"id":46,"kind":4,"name":"DashboardLayoutChange","url":"enums/tableau.dashboardlayoutchange.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":47,"kind":16,"name":"Added","url":"enums/tableau.dashboardlayoutchange.html#added","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":48,"kind":16,"name":"Removed","url":"enums/tableau.dashboardlayoutchange.html#removed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":49,"kind":16,"name":"IsFloatingChanged","url":"enums/tableau.dashboardlayoutchange.html#isfloatingchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":50,"kind":16,"name":"IsVisibleChanged","url":"enums/tableau.dashboardlayoutchange.html#isvisiblechanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":51,"kind":16,"name":"PositionChanged","url":"enums/tableau.dashboardlayoutchange.html#positionchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":52,"kind":16,"name":"SizeChanged","url":"enums/tableau.dashboardlayoutchange.html#sizechanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":53,"kind":16,"name":"NameChanged","url":"enums/tableau.dashboardlayoutchange.html#namechanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":54,"kind":16,"name":"Selected","url":"enums/tableau.dashboardlayoutchange.html#selected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":55,"kind":16,"name":"Deselected","url":"enums/tableau.dashboardlayoutchange.html#deselected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":56,"kind":16,"name":"DashboardChanged","url":"enums/tableau.dashboardlayoutchange.html#dashboardchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DashboardLayoutChange"},{"id":57,"kind":4,"name":"DateRangeType","url":"enums/tableau.daterangetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":58,"kind":16,"name":"Last","url":"enums/tableau.daterangetype.html#last","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":59,"kind":16,"name":"LastN","url":"enums/tableau.daterangetype.html#lastn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":60,"kind":16,"name":"Next","url":"enums/tableau.daterangetype.html#next","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":61,"kind":16,"name":"NextN","url":"enums/tableau.daterangetype.html#nextn","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":62,"kind":16,"name":"Current","url":"enums/tableau.daterangetype.html#current","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":63,"kind":16,"name":"ToDate","url":"enums/tableau.daterangetype.html#todate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DateRangeType"},{"id":64,"kind":4,"name":"DialogStyle","url":"enums/tableau.dialogstyle.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":65,"kind":16,"name":"Window","url":"enums/tableau.dialogstyle.html#window","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DialogStyle"},{"id":66,"kind":16,"name":"Modal","url":"enums/tableau.dialogstyle.html#modal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DialogStyle"},{"id":67,"kind":16,"name":"Modeless","url":"enums/tableau.dialogstyle.html#modeless","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.DialogStyle"},{"id":68,"kind":4,"name":"EncodingType","url":"enums/tableau.encodingtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":69,"kind":16,"name":"Column","url":"enums/tableau.encodingtype.html#column","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":70,"kind":16,"name":"Row","url":"enums/tableau.encodingtype.html#row","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":71,"kind":16,"name":"Page","url":"enums/tableau.encodingtype.html#page","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":72,"kind":16,"name":"Filter","url":"enums/tableau.encodingtype.html#filter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":73,"kind":16,"name":"MarksType","url":"enums/tableau.encodingtype.html#markstype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":74,"kind":16,"name":"MeasureValues","url":"enums/tableau.encodingtype.html#measurevalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":75,"kind":16,"name":"Color","url":"enums/tableau.encodingtype.html#color","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":76,"kind":16,"name":"Size","url":"enums/tableau.encodingtype.html#size","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":77,"kind":16,"name":"Label","url":"enums/tableau.encodingtype.html#label","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":78,"kind":16,"name":"Detail","url":"enums/tableau.encodingtype.html#detail","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":79,"kind":16,"name":"Tooltip","url":"enums/tableau.encodingtype.html#tooltip","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":80,"kind":16,"name":"Shape","url":"enums/tableau.encodingtype.html#shape","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":81,"kind":16,"name":"Path","url":"enums/tableau.encodingtype.html#path","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":82,"kind":16,"name":"Angle","url":"enums/tableau.encodingtype.html#angle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":83,"kind":16,"name":"Geometry","url":"enums/tableau.encodingtype.html#geometry","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":84,"kind":16,"name":"Custom","url":"enums/tableau.encodingtype.html#custom","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.EncodingType"},{"id":85,"kind":4,"name":"FieldAggregationType","url":"enums/tableau.fieldaggregationtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":86,"kind":16,"name":"Sum","url":"enums/tableau.fieldaggregationtype.html#sum","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":87,"kind":16,"name":"Avg","url":"enums/tableau.fieldaggregationtype.html#avg","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":88,"kind":16,"name":"Min","url":"enums/tableau.fieldaggregationtype.html#min","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":89,"kind":16,"name":"Max","url":"enums/tableau.fieldaggregationtype.html#max","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":90,"kind":16,"name":"Stdev","url":"enums/tableau.fieldaggregationtype.html#stdev","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":91,"kind":16,"name":"Stdevp","url":"enums/tableau.fieldaggregationtype.html#stdevp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":92,"kind":16,"name":"Var","url":"enums/tableau.fieldaggregationtype.html#var","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":93,"kind":16,"name":"Varp","url":"enums/tableau.fieldaggregationtype.html#varp","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":94,"kind":16,"name":"Collect","url":"enums/tableau.fieldaggregationtype.html#collect","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":95,"kind":16,"name":"Count","url":"enums/tableau.fieldaggregationtype.html#count","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":96,"kind":16,"name":"Countd","url":"enums/tableau.fieldaggregationtype.html#countd","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":97,"kind":16,"name":"Median","url":"enums/tableau.fieldaggregationtype.html#median","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":98,"kind":16,"name":"Attr","url":"enums/tableau.fieldaggregationtype.html#attr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":99,"kind":16,"name":"None","url":"enums/tableau.fieldaggregationtype.html#none","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":100,"kind":16,"name":"Year","url":"enums/tableau.fieldaggregationtype.html#year","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":101,"kind":16,"name":"Qtr","url":"enums/tableau.fieldaggregationtype.html#qtr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":102,"kind":16,"name":"Month","url":"enums/tableau.fieldaggregationtype.html#month","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":103,"kind":16,"name":"Day","url":"enums/tableau.fieldaggregationtype.html#day","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":104,"kind":16,"name":"Hour","url":"enums/tableau.fieldaggregationtype.html#hour","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":105,"kind":16,"name":"Minute","url":"enums/tableau.fieldaggregationtype.html#minute","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":106,"kind":16,"name":"Second","url":"enums/tableau.fieldaggregationtype.html#second","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":107,"kind":16,"name":"Week","url":"enums/tableau.fieldaggregationtype.html#week","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":108,"kind":16,"name":"Weekday","url":"enums/tableau.fieldaggregationtype.html#weekday","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":109,"kind":16,"name":"MonthYear","url":"enums/tableau.fieldaggregationtype.html#monthyear","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":110,"kind":16,"name":"Mdy","url":"enums/tableau.fieldaggregationtype.html#mdy","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":111,"kind":16,"name":"End","url":"enums/tableau.fieldaggregationtype.html#end","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":112,"kind":16,"name":"TruncYear","url":"enums/tableau.fieldaggregationtype.html#truncyear","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":113,"kind":16,"name":"TruncQtr","url":"enums/tableau.fieldaggregationtype.html#truncqtr","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":114,"kind":16,"name":"TruncMonth","url":"enums/tableau.fieldaggregationtype.html#truncmonth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":115,"kind":16,"name":"TruncWeek","url":"enums/tableau.fieldaggregationtype.html#truncweek","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":116,"kind":16,"name":"TruncDay","url":"enums/tableau.fieldaggregationtype.html#truncday","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":117,"kind":16,"name":"TruncHour","url":"enums/tableau.fieldaggregationtype.html#trunchour","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":118,"kind":16,"name":"TruncMinute","url":"enums/tableau.fieldaggregationtype.html#truncminute","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":119,"kind":16,"name":"TruncSecond","url":"enums/tableau.fieldaggregationtype.html#truncsecond","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":120,"kind":16,"name":"Quart1","url":"enums/tableau.fieldaggregationtype.html#quart1","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":121,"kind":16,"name":"Quart3","url":"enums/tableau.fieldaggregationtype.html#quart3","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":122,"kind":16,"name":"Skewness","url":"enums/tableau.fieldaggregationtype.html#skewness","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":123,"kind":16,"name":"Kurtosis","url":"enums/tableau.fieldaggregationtype.html#kurtosis","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":124,"kind":16,"name":"InOut","url":"enums/tableau.fieldaggregationtype.html#inout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":125,"kind":16,"name":"User","url":"enums/tableau.fieldaggregationtype.html#user","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldAggregationType"},{"id":126,"kind":4,"name":"FieldRoleType","url":"enums/tableau.fieldroletype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":127,"kind":16,"name":"Dimension","url":"enums/tableau.fieldroletype.html#dimension","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldRoleType"},{"id":128,"kind":16,"name":"Measure","url":"enums/tableau.fieldroletype.html#measure","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldRoleType"},{"id":129,"kind":16,"name":"Unknown","url":"enums/tableau.fieldroletype.html#unknown","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FieldRoleType"},{"id":130,"kind":4,"name":"FilterType","url":"enums/tableau.filtertype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":131,"kind":16,"name":"Categorical","url":"enums/tableau.filtertype.html#categorical","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterType"},{"id":132,"kind":16,"name":"Range","url":"enums/tableau.filtertype.html#range","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterType"},{"id":133,"kind":16,"name":"Hierarchical","url":"enums/tableau.filtertype.html#hierarchical","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterType"},{"id":134,"kind":16,"name":"RelativeDate","url":"enums/tableau.filtertype.html#relativedate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterType"},{"id":135,"kind":4,"name":"FilterUpdateType","url":"enums/tableau.filterupdatetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":136,"kind":16,"name":"Add","url":"enums/tableau.filterupdatetype.html#add","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterUpdateType"},{"id":137,"kind":16,"name":"All","url":"enums/tableau.filterupdatetype.html#all","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterUpdateType"},{"id":138,"kind":16,"name":"Replace","url":"enums/tableau.filterupdatetype.html#replace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterUpdateType"},{"id":139,"kind":16,"name":"Remove","url":"enums/tableau.filterupdatetype.html#remove","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterUpdateType"},{"id":140,"kind":4,"name":"FilterDomainType","url":"enums/tableau.filterdomaintype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":141,"kind":16,"name":"Relevant","url":"enums/tableau.filterdomaintype.html#relevant","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterDomainType"},{"id":142,"kind":16,"name":"Database","url":"enums/tableau.filterdomaintype.html#database","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterDomainType"},{"id":143,"kind":4,"name":"FilterNullOption","url":"enums/tableau.filternulloption.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":144,"kind":16,"name":"NullValues","url":"enums/tableau.filternulloption.html#nullvalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterNullOption"},{"id":145,"kind":16,"name":"NonNullValues","url":"enums/tableau.filternulloption.html#nonnullvalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterNullOption"},{"id":146,"kind":16,"name":"AllValues","url":"enums/tableau.filternulloption.html#allvalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.FilterNullOption"},{"id":147,"kind":4,"name":"IncludeDataValuesOption","url":"enums/tableau.includedatavaluesoption.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":148,"kind":16,"name":"AllValues","url":"enums/tableau.includedatavaluesoption.html#allvalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.IncludeDataValuesOption"},{"id":149,"kind":16,"name":"OnlyNativeValues","url":"enums/tableau.includedatavaluesoption.html#onlynativevalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.IncludeDataValuesOption"},{"id":150,"kind":16,"name":"OnlyFormattedValues","url":"enums/tableau.includedatavaluesoption.html#onlyformattedvalues","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.IncludeDataValuesOption"},{"id":151,"kind":4,"name":"MarkType","url":"enums/tableau.marktype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":152,"kind":16,"name":"Bar","url":"enums/tableau.marktype.html#bar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":153,"kind":16,"name":"Line","url":"enums/tableau.marktype.html#line","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":154,"kind":16,"name":"Area","url":"enums/tableau.marktype.html#area","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":155,"kind":16,"name":"Square","url":"enums/tableau.marktype.html#square","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":156,"kind":16,"name":"Circle","url":"enums/tableau.marktype.html#circle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":157,"kind":16,"name":"Shape","url":"enums/tableau.marktype.html#shape","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":158,"kind":16,"name":"Text","url":"enums/tableau.marktype.html#text","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":159,"kind":16,"name":"Map","url":"enums/tableau.marktype.html#map","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":160,"kind":16,"name":"Pie","url":"enums/tableau.marktype.html#pie","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":161,"kind":16,"name":"GanttBar","url":"enums/tableau.marktype.html#ganttbar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":162,"kind":16,"name":"Polygon","url":"enums/tableau.marktype.html#polygon","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":163,"kind":16,"name":"Heatmap","url":"enums/tableau.marktype.html#heatmap","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":164,"kind":16,"name":"VizExtension","url":"enums/tableau.marktype.html#vizextension","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.MarkType"},{"id":165,"kind":4,"name":"ParameterValueType","url":"enums/tableau.parametervaluetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":166,"kind":16,"name":"All","url":"enums/tableau.parametervaluetype.html#all","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ParameterValueType"},{"id":167,"kind":16,"name":"List","url":"enums/tableau.parametervaluetype.html#list","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ParameterValueType"},{"id":168,"kind":16,"name":"Range","url":"enums/tableau.parametervaluetype.html#range","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ParameterValueType"},{"id":169,"kind":4,"name":"PeriodType","url":"enums/tableau.periodtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":170,"kind":16,"name":"Years","url":"enums/tableau.periodtype.html#years","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":171,"kind":16,"name":"Quarters","url":"enums/tableau.periodtype.html#quarters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":172,"kind":16,"name":"Months","url":"enums/tableau.periodtype.html#months","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":173,"kind":16,"name":"Weeks","url":"enums/tableau.periodtype.html#weeks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":174,"kind":16,"name":"Days","url":"enums/tableau.periodtype.html#days","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":175,"kind":16,"name":"Hours","url":"enums/tableau.periodtype.html#hours","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":176,"kind":16,"name":"Minutes","url":"enums/tableau.periodtype.html#minutes","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":177,"kind":16,"name":"Seconds","url":"enums/tableau.periodtype.html#seconds","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":178,"kind":16,"name":"IsoYears","url":"enums/tableau.periodtype.html#isoyears","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":179,"kind":16,"name":"IsoQuarters","url":"enums/tableau.periodtype.html#isoquarters","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":180,"kind":16,"name":"IsoWeeks","url":"enums/tableau.periodtype.html#isoweeks","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.PeriodType"},{"id":181,"kind":4,"name":"QuickTableCalcType","url":"enums/tableau.quicktablecalctype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":182,"kind":16,"name":"RunningTotal","url":"enums/tableau.quicktablecalctype.html#runningtotal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":183,"kind":16,"name":"Difference","url":"enums/tableau.quicktablecalctype.html#difference","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":184,"kind":16,"name":"PercentDifference","url":"enums/tableau.quicktablecalctype.html#percentdifference","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":185,"kind":16,"name":"PercentOfTotal","url":"enums/tableau.quicktablecalctype.html#percentoftotal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":186,"kind":16,"name":"Rank","url":"enums/tableau.quicktablecalctype.html#rank","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":187,"kind":16,"name":"Percentile","url":"enums/tableau.quicktablecalctype.html#percentile","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":188,"kind":16,"name":"MovingAverage","url":"enums/tableau.quicktablecalctype.html#movingaverage","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":189,"kind":16,"name":"YTDTotal","url":"enums/tableau.quicktablecalctype.html#ytdtotal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":190,"kind":16,"name":"CompoundGrowthRate","url":"enums/tableau.quicktablecalctype.html#compoundgrowthrate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":191,"kind":16,"name":"YearOverYearGrowth","url":"enums/tableau.quicktablecalctype.html#yearoveryeargrowth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":192,"kind":16,"name":"YTDGrowth","url":"enums/tableau.quicktablecalctype.html#ytdgrowth","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":193,"kind":16,"name":"Undefined","url":"enums/tableau.quicktablecalctype.html#undefined","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.QuickTableCalcType"},{"id":194,"kind":4,"name":"SelectionUpdateType","url":"enums/tableau.selectionupdatetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":195,"kind":16,"name":"Replace","url":"enums/tableau.selectionupdatetype.html#replace","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SelectionUpdateType"},{"id":196,"kind":16,"name":"Add","url":"enums/tableau.selectionupdatetype.html#add","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SelectionUpdateType"},{"id":197,"kind":16,"name":"Remove","url":"enums/tableau.selectionupdatetype.html#remove","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SelectionUpdateType"},{"id":198,"kind":4,"name":"SelectOptions","url":"enums/tableau.selectoptions.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":199,"kind":16,"name":"Simple","url":"enums/tableau.selectoptions.html#simple","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SelectOptions"},{"id":200,"kind":16,"name":"Toggle","url":"enums/tableau.selectoptions.html#toggle","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SelectOptions"},{"id":201,"kind":4,"name":"SheetType","url":"enums/tableau.sheettype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":202,"kind":16,"name":"Dashboard","url":"enums/tableau.sheettype.html#dashboard","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SheetType"},{"id":203,"kind":16,"name":"Story","url":"enums/tableau.sheettype.html#story","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SheetType"},{"id":204,"kind":16,"name":"Worksheet","url":"enums/tableau.sheettype.html#worksheet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SheetType"},{"id":205,"kind":4,"name":"SortDirection","url":"enums/tableau.sortdirection.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":206,"kind":16,"name":"Increasing","url":"enums/tableau.sortdirection.html#increasing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SortDirection"},{"id":207,"kind":16,"name":"Decreasing","url":"enums/tableau.sortdirection.html#decreasing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.SortDirection"},{"id":208,"kind":4,"name":"TrendLineModelType","url":"enums/tableau.trendlinemodeltype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":209,"kind":16,"name":"Linear","url":"enums/tableau.trendlinemodeltype.html#linear","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TrendLineModelType"},{"id":210,"kind":16,"name":"Logarithmic","url":"enums/tableau.trendlinemodeltype.html#logarithmic","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TrendLineModelType"},{"id":211,"kind":16,"name":"Exponential","url":"enums/tableau.trendlinemodeltype.html#exponential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TrendLineModelType"},{"id":212,"kind":16,"name":"Polynomial","url":"enums/tableau.trendlinemodeltype.html#polynomial","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TrendLineModelType"},{"id":213,"kind":4,"name":"ReplaySpeedType","url":"enums/tableau.replayspeedtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":214,"kind":16,"name":"Slow","url":"enums/tableau.replayspeedtype.html#slow","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ReplaySpeedType"},{"id":215,"kind":16,"name":"Normal","url":"enums/tableau.replayspeedtype.html#normal","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ReplaySpeedType"},{"id":216,"kind":16,"name":"Fast","url":"enums/tableau.replayspeedtype.html#fast","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ReplaySpeedType"},{"id":217,"kind":4,"name":"HierarchicalLevelSelectionState","url":"enums/tableau.hierarchicallevelselectionstate.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":218,"kind":16,"name":"AllSelected","url":"enums/tableau.hierarchicallevelselectionstate.html#allselected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.HierarchicalLevelSelectionState"},{"id":219,"kind":16,"name":"NoneSelected","url":"enums/tableau.hierarchicallevelselectionstate.html#noneselected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.HierarchicalLevelSelectionState"},{"id":220,"kind":16,"name":"SomeSelected","url":"enums/tableau.hierarchicallevelselectionstate.html#someselected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.HierarchicalLevelSelectionState"},{"id":221,"kind":16,"name":"UnknownSelected","url":"enums/tableau.hierarchicallevelselectionstate.html#unknownselected","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.HierarchicalLevelSelectionState"},{"id":222,"kind":4194304,"name":"ZoneVisibilityType","url":"modules/tableau.html#zonevisibilitytype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"Tableau"},{"id":223,"kind":2097152,"name":"ZoneVisibilityType","url":"modules/tableau.html#zonevisibilitytype-1","classes":"tsd-kind-object-literal tsd-parent-kind-module","parent":"Tableau"},{"id":224,"kind":256,"name":"Annotation","url":"interfaces/annotation.html","classes":"tsd-kind-interface"},{"id":225,"kind":1024,"name":"annotationHTML","url":"interfaces/annotation.html#annotationhtml","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Annotation"},{"id":226,"kind":1024,"name":"annotationId","url":"interfaces/annotation.html#annotationid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Annotation"},{"id":227,"kind":1024,"name":"annotationText","url":"interfaces/annotation.html#annotationtext","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Annotation"},{"id":228,"kind":1024,"name":"annotationType","url":"interfaces/annotation.html#annotationtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Annotation"},{"id":229,"kind":1024,"name":"tupleId","url":"interfaces/annotation.html#tupleid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Annotation"},{"id":230,"kind":256,"name":"Size","url":"interfaces/size.html","classes":"tsd-kind-interface"},{"id":231,"kind":1024,"name":"height","url":"interfaces/size.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Size"},{"id":232,"kind":1024,"name":"width","url":"interfaces/size.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Size"},{"id":233,"kind":256,"name":"VisualSpecification","url":"interfaces/visualspecification.html","classes":"tsd-kind-interface"},{"id":234,"kind":1024,"name":"rowFields","url":"interfaces/visualspecification.html#rowfields","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"VisualSpecification"},{"id":235,"kind":1024,"name":"columnFields","url":"interfaces/visualspecification.html#columnfields","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"VisualSpecification"},{"id":236,"kind":1024,"name":"activeMarksSpecificationIndex","url":"interfaces/visualspecification.html#activemarksspecificationindex","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"VisualSpecification"},{"id":237,"kind":1024,"name":"marksSpecifications","url":"interfaces/visualspecification.html#marksspecifications","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"VisualSpecification"},{"id":238,"kind":256,"name":"MarksSpecification","url":"interfaces/marksspecification.html","classes":"tsd-kind-interface"},{"id":239,"kind":1024,"name":"primitiveType","url":"interfaces/marksspecification.html#primitivetype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarksSpecification"},{"id":240,"kind":1024,"name":"encodings","url":"interfaces/marksspecification.html#encodings","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarksSpecification"},{"id":241,"kind":256,"name":"Encoding","url":"interfaces/encoding.html","classes":"tsd-kind-interface"},{"id":242,"kind":1024,"name":"id","url":"interfaces/encoding.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Encoding"},{"id":243,"kind":1024,"name":"fieldEncodingId","url":"interfaces/encoding.html#fieldencodingid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Encoding"},{"id":244,"kind":1024,"name":"type","url":"interfaces/encoding.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Encoding"},{"id":245,"kind":1024,"name":"field","url":"interfaces/encoding.html#field","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Encoding"},{"id":246,"kind":256,"name":"FieldInstance","url":"interfaces/fieldinstance.html","classes":"tsd-kind-interface"},{"id":247,"kind":1024,"name":"fieldId","url":"interfaces/fieldinstance.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FieldInstance"},{"id":248,"kind":1024,"name":"name","url":"interfaces/fieldinstance.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":249,"kind":1024,"name":"description","url":"interfaces/fieldinstance.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":250,"kind":1024,"name":"dataType","url":"interfaces/fieldinstance.html#datatype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":251,"kind":1024,"name":"role","url":"interfaces/fieldinstance.html#role","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":252,"kind":1024,"name":"aggregation","url":"interfaces/fieldinstance.html#aggregation","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":253,"kind":1024,"name":"columnType","url":"interfaces/fieldinstance.html#columntype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":254,"kind":1024,"name":"isCalculatedField","url":"interfaces/fieldinstance.html#iscalculatedfield","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":255,"kind":1024,"name":"isCombinedField","url":"interfaces/fieldinstance.html#iscombinedfield","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":256,"kind":1024,"name":"isGenerated","url":"interfaces/fieldinstance.html#isgenerated","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":257,"kind":1024,"name":"isGeospatial","url":"interfaces/fieldinstance.html#isgeospatial","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":258,"kind":1024,"name":"isHidden","url":"interfaces/fieldinstance.html#ishidden","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":259,"kind":1024,"name":"isPresentOnPublishedDatasource","url":"interfaces/fieldinstance.html#ispresentonpublisheddatasource","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FieldInstance"},{"id":260,"kind":256,"name":"WorkbookFormatting","url":"interfaces/workbookformatting.html","classes":"tsd-kind-interface"},{"id":261,"kind":1024,"name":"formattingSheets","url":"interfaces/workbookformatting.html#formattingsheets","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorkbookFormatting"},{"id":262,"kind":256,"name":"FormattingSheet","url":"interfaces/formattingsheet.html","classes":"tsd-kind-interface"},{"id":263,"kind":1024,"name":"classNameKey","url":"interfaces/formattingsheet.html#classnamekey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattingSheet"},{"id":264,"kind":1024,"name":"cssProperties","url":"interfaces/formattingsheet.html#cssproperties","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FormattingSheet"},{"id":265,"kind":4194304,"name":"WorksheetFormatting","url":"globals.html#worksheetformatting","classes":"tsd-kind-type-alias"},{"id":266,"kind":256,"name":"Parameter","url":"interfaces/parameter.html","classes":"tsd-kind-interface"},{"id":267,"kind":1024,"name":"name","url":"interfaces/parameter.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Parameter"},{"id":268,"kind":1024,"name":"currentValue","url":"interfaces/parameter.html#currentvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Parameter"},{"id":269,"kind":1024,"name":"dataType","url":"interfaces/parameter.html#datatype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Parameter"},{"id":270,"kind":1024,"name":"allowableValues","url":"interfaces/parameter.html#allowablevalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Parameter"},{"id":271,"kind":1024,"name":"id","url":"interfaces/parameter.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Parameter"},{"id":272,"kind":2048,"name":"changeValueAsync","url":"interfaces/parameter.html#changevalueasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Parameter"},{"id":273,"kind":2048,"name":"addEventListener","url":"interfaces/parameter.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Parameter"},{"id":274,"kind":2048,"name":"removeEventListener","url":"interfaces/parameter.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Parameter"},{"id":275,"kind":256,"name":"ParameterDomainRestriction","url":"interfaces/parameterdomainrestriction.html","classes":"tsd-kind-interface"},{"id":276,"kind":1024,"name":"type","url":"interfaces/parameterdomainrestriction.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":277,"kind":1024,"name":"allowableValues","url":"interfaces/parameterdomainrestriction.html#allowablevalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":278,"kind":1024,"name":"minValue","url":"interfaces/parameterdomainrestriction.html#minvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":279,"kind":1024,"name":"maxValue","url":"interfaces/parameterdomainrestriction.html#maxvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":280,"kind":1024,"name":"stepSize","url":"interfaces/parameterdomainrestriction.html#stepsize","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":281,"kind":1024,"name":"dateStepPeriod","url":"interfaces/parameterdomainrestriction.html#datestepperiod","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ParameterDomainRestriction"},{"id":282,"kind":256,"name":"Sheet","url":"interfaces/sheet.html","classes":"tsd-kind-interface"},{"id":283,"kind":1024,"name":"name","url":"interfaces/sheet.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Sheet"},{"id":284,"kind":1024,"name":"sheetType","url":"interfaces/sheet.html#sheettype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Sheet"},{"id":285,"kind":2048,"name":"findParameterAsync","url":"interfaces/sheet.html#findparameterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Sheet"},{"id":286,"kind":1024,"name":"size","url":"interfaces/sheet.html#size","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Sheet"},{"id":287,"kind":2048,"name":"getParametersAsync","url":"interfaces/sheet.html#getparametersasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Sheet"},{"id":288,"kind":2048,"name":"addEventListener","url":"interfaces/sheet.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Sheet"},{"id":289,"kind":2048,"name":"removeEventListener","url":"interfaces/sheet.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Sheet"},{"id":290,"kind":256,"name":"Worksheet","url":"interfaces/worksheet.html","classes":"tsd-kind-interface"},{"id":291,"kind":1024,"name":"parentDashboard","url":"interfaces/worksheet.html#parentdashboard","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Worksheet"},{"id":292,"kind":1024,"name":"backgroundColor","url":"interfaces/worksheet.html#backgroundcolor","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Worksheet"},{"id":293,"kind":1024,"name":"formatting","url":"interfaces/worksheet.html#formatting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Worksheet"},{"id":294,"kind":2048,"name":"applyFilterAsync","url":"interfaces/worksheet.html#applyfilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":295,"kind":2048,"name":"applyRangeFilterAsync","url":"interfaces/worksheet.html#applyrangefilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":296,"kind":2048,"name":"clearFilterAsync","url":"interfaces/worksheet.html#clearfilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":297,"kind":2048,"name":"applyHierarchicalFilterAsync","url":"interfaces/worksheet.html#applyhierarchicalfilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":298,"kind":2048,"name":"applyRelativeDateFilterAsync","url":"interfaces/worksheet.html#applyrelativedatefilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":299,"kind":2048,"name":"getDataSourcesAsync","url":"interfaces/worksheet.html#getdatasourcesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":300,"kind":2048,"name":"getFiltersAsync","url":"interfaces/worksheet.html#getfiltersasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":301,"kind":2048,"name":"getHighlightedMarksAsync","url":"interfaces/worksheet.html#gethighlightedmarksasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":302,"kind":2048,"name":"getSelectedMarksAsync","url":"interfaces/worksheet.html#getselectedmarksasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":303,"kind":2048,"name":"getSummaryDataAsync","url":"interfaces/worksheet.html#getsummarydataasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":304,"kind":2048,"name":"getSummaryDataReaderAsync","url":"interfaces/worksheet.html#getsummarydatareaderasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":305,"kind":2048,"name":"getSummaryColumnsInfoAsync","url":"interfaces/worksheet.html#getsummarycolumnsinfoasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":306,"kind":2048,"name":"getUnderlyingDataAsync","url":"interfaces/worksheet.html#getunderlyingdataasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":307,"kind":2048,"name":"getUnderlyingTablesAsync","url":"interfaces/worksheet.html#getunderlyingtablesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":308,"kind":2048,"name":"getUnderlyingTableDataAsync","url":"interfaces/worksheet.html#getunderlyingtabledataasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":309,"kind":2048,"name":"getUnderlyingTableDataReaderAsync","url":"interfaces/worksheet.html#getunderlyingtabledatareaderasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":310,"kind":2048,"name":"selectMarksByValueAsync","url":"interfaces/worksheet.html#selectmarksbyvalueasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":311,"kind":2048,"name":"clearSelectedMarksAsync","url":"interfaces/worksheet.html#clearselectedmarksasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":312,"kind":2048,"name":"annotateMarkAsync","url":"interfaces/worksheet.html#annotatemarkasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":313,"kind":2048,"name":"getAnnotationsAsync","url":"interfaces/worksheet.html#getannotationsasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":314,"kind":2048,"name":"removeAnnotationAsync","url":"interfaces/worksheet.html#removeannotationasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":315,"kind":2048,"name":"getVisualSpecificationAsync","url":"interfaces/worksheet.html#getvisualspecificationasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":316,"kind":2048,"name":"hoverTupleAsync","url":"interfaces/worksheet.html#hovertupleasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":317,"kind":2048,"name":"selectTuplesAsync","url":"interfaces/worksheet.html#selecttuplesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":318,"kind":2048,"name":"getTooltipTextAsync","url":"interfaces/worksheet.html#gettooltiptextasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":319,"kind":2048,"name":"leaveMarkNavigationAsync","url":"interfaces/worksheet.html#leavemarknavigationasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Worksheet"},{"id":320,"kind":1024,"name":"name","url":"interfaces/worksheet.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":321,"kind":1024,"name":"sheetType","url":"interfaces/worksheet.html#sheettype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":322,"kind":2048,"name":"findParameterAsync","url":"interfaces/worksheet.html#findparameterasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":323,"kind":1024,"name":"size","url":"interfaces/worksheet.html#size","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":324,"kind":2048,"name":"getParametersAsync","url":"interfaces/worksheet.html#getparametersasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":325,"kind":2048,"name":"addEventListener","url":"interfaces/worksheet.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":326,"kind":2048,"name":"removeEventListener","url":"interfaces/worksheet.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Worksheet"},{"id":327,"kind":256,"name":"Dashboard","url":"interfaces/dashboard.html","classes":"tsd-kind-interface"},{"id":328,"kind":1024,"name":"objects","url":"interfaces/dashboard.html#objects","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Dashboard"},{"id":329,"kind":1024,"name":"worksheets","url":"interfaces/dashboard.html#worksheets","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Dashboard"},{"id":330,"kind":1024,"name":"activeDashboardObjectId","url":"interfaces/dashboard.html#activedashboardobjectid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Dashboard"},{"id":331,"kind":1024,"name":"activeDashboardName","url":"interfaces/dashboard.html#activedashboardname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Dashboard"},{"id":332,"kind":2048,"name":"setZoneVisibilityAsync","url":"interfaces/dashboard.html#setzonevisibilityasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":333,"kind":2048,"name":"setDashboardObjectVisibilityAsync","url":"interfaces/dashboard.html#setdashboardobjectvisibilityasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":334,"kind":2048,"name":"getDashboardObjectById","url":"interfaces/dashboard.html#getdashboardobjectbyid","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":335,"kind":2048,"name":"moveAndResizeDashboardObjectsAsync","url":"interfaces/dashboard.html#moveandresizedashboardobjectsasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":336,"kind":2048,"name":"replayAnimationAsync","url":"interfaces/dashboard.html#replayanimationasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":337,"kind":2048,"name":"getFiltersAsync","url":"interfaces/dashboard.html#getfiltersasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":338,"kind":2048,"name":"applyFilterAsync","url":"interfaces/dashboard.html#applyfilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Dashboard"},{"id":339,"kind":1024,"name":"name","url":"interfaces/dashboard.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":340,"kind":1024,"name":"sheetType","url":"interfaces/dashboard.html#sheettype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":341,"kind":2048,"name":"findParameterAsync","url":"interfaces/dashboard.html#findparameterasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":342,"kind":1024,"name":"size","url":"interfaces/dashboard.html#size","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":343,"kind":2048,"name":"getParametersAsync","url":"interfaces/dashboard.html#getparametersasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":344,"kind":2048,"name":"addEventListener","url":"interfaces/dashboard.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":345,"kind":2048,"name":"removeEventListener","url":"interfaces/dashboard.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Dashboard"},{"id":346,"kind":256,"name":"DashboardObjectPositionAndSizeUpdate","url":"interfaces/dashboardobjectpositionandsizeupdate.html","classes":"tsd-kind-interface"},{"id":347,"kind":1024,"name":"dashboardObjectID","url":"interfaces/dashboardobjectpositionandsizeupdate.html#dashboardobjectid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObjectPositionAndSizeUpdate"},{"id":348,"kind":1024,"name":"x","url":"interfaces/dashboardobjectpositionandsizeupdate.html#x","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObjectPositionAndSizeUpdate"},{"id":349,"kind":1024,"name":"y","url":"interfaces/dashboardobjectpositionandsizeupdate.html#y","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObjectPositionAndSizeUpdate"},{"id":350,"kind":1024,"name":"width","url":"interfaces/dashboardobjectpositionandsizeupdate.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObjectPositionAndSizeUpdate"},{"id":351,"kind":1024,"name":"height","url":"interfaces/dashboardobjectpositionandsizeupdate.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObjectPositionAndSizeUpdate"},{"id":352,"kind":256,"name":"DashboardObject","url":"interfaces/dashboardobject.html","classes":"tsd-kind-interface"},{"id":353,"kind":1024,"name":"dashboard","url":"interfaces/dashboardobject.html#dashboard","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":354,"kind":1024,"name":"type","url":"interfaces/dashboardobject.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":355,"kind":1024,"name":"position","url":"interfaces/dashboardobject.html#position","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":356,"kind":1024,"name":"size","url":"interfaces/dashboardobject.html#size","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":357,"kind":1024,"name":"worksheet","url":"interfaces/dashboardobject.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":358,"kind":1024,"name":"name","url":"interfaces/dashboardobject.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":359,"kind":1024,"name":"isFloating","url":"interfaces/dashboardobject.html#isfloating","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":360,"kind":1024,"name":"isVisible","url":"interfaces/dashboardobject.html#isvisible","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":361,"kind":1024,"name":"id","url":"interfaces/dashboardobject.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":362,"kind":1024,"name":"fieldId","url":"interfaces/dashboardobject.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardObject"},{"id":363,"kind":256,"name":"Point","url":"interfaces/point.html","classes":"tsd-kind-interface"},{"id":364,"kind":1024,"name":"x","url":"interfaces/point.html#x","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Point"},{"id":365,"kind":1024,"name":"y","url":"interfaces/point.html#y","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Point"},{"id":366,"kind":256,"name":"HierarchicalLevels","url":"interfaces/hierarchicallevels.html","classes":"tsd-kind-interface"},{"id":367,"kind":1024,"name":"levels","url":"interfaces/hierarchicallevels.html#levels","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalLevels"},{"id":368,"kind":4194304,"name":"ZoneVisibilityMap","url":"globals.html#zonevisibilitymap","classes":"tsd-kind-type-alias"},{"id":369,"kind":4194304,"name":"DashboardObjectVisibilityMap","url":"globals.html#dashboardobjectvisibilitymap","classes":"tsd-kind-type-alias"},{"id":370,"kind":4194304,"name":"DashboardObjectPositionAndSizeUpdateArray","url":"globals.html#dashboardobjectpositionandsizeupdatearray","classes":"tsd-kind-type-alias"},{"id":371,"kind":256,"name":"MarksCollection","url":"interfaces/markscollection.html","classes":"tsd-kind-interface"},{"id":372,"kind":1024,"name":"data","url":"interfaces/markscollection.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarksCollection"},{"id":373,"kind":256,"name":"MarkInfo","url":"interfaces/markinfo.html","classes":"tsd-kind-interface"},{"id":374,"kind":1024,"name":"type","url":"interfaces/markinfo.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarkInfo"},{"id":375,"kind":1024,"name":"color","url":"interfaces/markinfo.html#color","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarkInfo"},{"id":376,"kind":1024,"name":"tupleId","url":"interfaces/markinfo.html#tupleid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"MarkInfo"},{"id":377,"kind":256,"name":"SelectionCriteria","url":"interfaces/selectioncriteria.html","classes":"tsd-kind-interface"},{"id":378,"kind":1024,"name":"fieldName","url":"interfaces/selectioncriteria.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelectionCriteria"},{"id":379,"kind":1024,"name":"value","url":"interfaces/selectioncriteria.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelectionCriteria"},{"id":380,"kind":256,"name":"RangeValue","url":"interfaces/rangevalue.html","classes":"tsd-kind-interface"},{"id":381,"kind":1024,"name":"min","url":"interfaces/rangevalue.html#min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeValue"},{"id":382,"kind":1024,"name":"max","url":"interfaces/rangevalue.html#max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeValue"},{"id":383,"kind":1024,"name":"nullOption","url":"interfaces/rangevalue.html#nulloption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeValue"},{"id":384,"kind":256,"name":"TooltipContext","url":"interfaces/tooltipcontext.html","classes":"tsd-kind-interface"},{"id":385,"kind":1024,"name":"tooltipAnchorPoint","url":"interfaces/tooltipcontext.html#tooltipanchorpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TooltipContext"},{"id":386,"kind":4194304,"name":"CategoricalValue","url":"globals.html#categoricalvalue","classes":"tsd-kind-type-alias"},{"id":387,"kind":256,"name":"Column","url":"interfaces/column.html","classes":"tsd-kind-interface"},{"id":388,"kind":1024,"name":"fieldName","url":"interfaces/column.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Column"},{"id":389,"kind":1024,"name":"fieldId","url":"interfaces/column.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Column"},{"id":390,"kind":1024,"name":"dataType","url":"interfaces/column.html#datatype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Column"},{"id":391,"kind":1024,"name":"isReferenced","url":"interfaces/column.html#isreferenced","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Column"},{"id":392,"kind":1024,"name":"index","url":"interfaces/column.html#index","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Column"},{"id":393,"kind":256,"name":"DataTable","url":"interfaces/datatable.html","classes":"tsd-kind-interface"},{"id":394,"kind":1024,"name":"name","url":"interfaces/datatable.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":395,"kind":1024,"name":"data","url":"interfaces/datatable.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":396,"kind":1024,"name":"marksInfo","url":"interfaces/datatable.html#marksinfo","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":397,"kind":1024,"name":"columns","url":"interfaces/datatable.html#columns","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":398,"kind":1024,"name":"totalRowCount","url":"interfaces/datatable.html#totalrowcount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":399,"kind":1024,"name":"isTotalRowCountLimited","url":"interfaces/datatable.html#istotalrowcountlimited","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":400,"kind":1024,"name":"isSummaryData","url":"interfaces/datatable.html#issummarydata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTable"},{"id":401,"kind":256,"name":"DataValue","url":"interfaces/datavalue.html","classes":"tsd-kind-interface"},{"id":402,"kind":1024,"name":"value","url":"interfaces/datavalue.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataValue"},{"id":403,"kind":1024,"name":"nativeValue","url":"interfaces/datavalue.html#nativevalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataValue"},{"id":404,"kind":1024,"name":"formattedValue","url":"interfaces/datavalue.html#formattedvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataValue"},{"id":405,"kind":1024,"name":"aliasValue","url":"interfaces/datavalue.html#aliasvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataValue"},{"id":406,"kind":1024,"name":"hasAlias","url":"interfaces/datavalue.html#hasalias","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataValue"},{"id":407,"kind":256,"name":"GetSummaryDataOptions","url":"interfaces/getsummarydataoptions.html","classes":"tsd-kind-interface"},{"id":408,"kind":1024,"name":"ignoreAliases","url":"interfaces/getsummarydataoptions.html#ignorealiases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":409,"kind":1024,"name":"ignoreSelection","url":"interfaces/getsummarydataoptions.html#ignoreselection","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":410,"kind":1024,"name":"columnsToIncludeById","url":"interfaces/getsummarydataoptions.html#columnstoincludebyid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":411,"kind":1024,"name":"maxRows","url":"interfaces/getsummarydataoptions.html#maxrows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":412,"kind":1024,"name":"includeDataValuesOption","url":"interfaces/getsummarydataoptions.html#includedatavaluesoption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":413,"kind":1024,"name":"applyWorksheetFormatting","url":"interfaces/getsummarydataoptions.html#applyworksheetformatting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetSummaryDataOptions"},{"id":414,"kind":256,"name":"GetUnderlyingDataOptions","url":"interfaces/getunderlyingdataoptions.html","classes":"tsd-kind-interface"},{"id":415,"kind":1024,"name":"includeAllColumns","url":"interfaces/getunderlyingdataoptions.html#includeallcolumns","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"GetUnderlyingDataOptions"},{"id":416,"kind":1024,"name":"ignoreAliases","url":"interfaces/getunderlyingdataoptions.html#ignorealiases","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":417,"kind":1024,"name":"ignoreSelection","url":"interfaces/getunderlyingdataoptions.html#ignoreselection","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":418,"kind":1024,"name":"columnsToIncludeById","url":"interfaces/getunderlyingdataoptions.html#columnstoincludebyid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":419,"kind":1024,"name":"maxRows","url":"interfaces/getunderlyingdataoptions.html#maxrows","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":420,"kind":1024,"name":"includeDataValuesOption","url":"interfaces/getunderlyingdataoptions.html#includedatavaluesoption","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":421,"kind":1024,"name":"applyWorksheetFormatting","url":"interfaces/getunderlyingdataoptions.html#applyworksheetformatting","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"GetUnderlyingDataOptions"},{"id":422,"kind":256,"name":"DataTableReader","url":"interfaces/datatablereader.html","classes":"tsd-kind-interface"},{"id":423,"kind":1024,"name":"totalRowCount","url":"interfaces/datatablereader.html#totalrowcount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTableReader"},{"id":424,"kind":1024,"name":"pageCount","url":"interfaces/datatablereader.html#pagecount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataTableReader"},{"id":425,"kind":2048,"name":"getPageAsync","url":"interfaces/datatablereader.html#getpageasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataTableReader"},{"id":426,"kind":2048,"name":"getAllPagesAsync","url":"interfaces/datatablereader.html#getallpagesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataTableReader"},{"id":427,"kind":2048,"name":"releaseAsync","url":"interfaces/datatablereader.html#releaseasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataTableReader"},{"id":428,"kind":256,"name":"DataSource","url":"interfaces/datasource.html","classes":"tsd-kind-interface"},{"id":429,"kind":1024,"name":"name","url":"interfaces/datasource.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":430,"kind":1024,"name":"id","url":"interfaces/datasource.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":431,"kind":1024,"name":"fields","url":"interfaces/datasource.html#fields","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":432,"kind":1024,"name":"extractUpdateTime","url":"interfaces/datasource.html#extractupdatetime","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":433,"kind":1024,"name":"isExtract","url":"interfaces/datasource.html#isextract","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":434,"kind":1024,"name":"isPublished","url":"interfaces/datasource.html#ispublished","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSource"},{"id":435,"kind":2048,"name":"refreshAsync","url":"interfaces/datasource.html#refreshasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":436,"kind":2048,"name":"getActiveTablesAsync","url":"interfaces/datasource.html#getactivetablesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":437,"kind":2048,"name":"getConnectionSummariesAsync","url":"interfaces/datasource.html#getconnectionsummariesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":438,"kind":2048,"name":"getUnderlyingDataAsync","url":"interfaces/datasource.html#getunderlyingdataasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":439,"kind":2048,"name":"getLogicalTablesAsync","url":"interfaces/datasource.html#getlogicaltablesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":440,"kind":2048,"name":"getLogicalTableDataAsync","url":"interfaces/datasource.html#getlogicaltabledataasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"DataSource"},{"id":441,"kind":256,"name":"Field","url":"interfaces/field.html","classes":"tsd-kind-interface"},{"id":442,"kind":1024,"name":"id","url":"interfaces/field.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Field"},{"id":443,"kind":1024,"name":"dataSource","url":"interfaces/field.html#datasource","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Field"},{"id":444,"kind":1024,"name":"name","url":"interfaces/field.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":445,"kind":1024,"name":"description","url":"interfaces/field.html#description","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":446,"kind":1024,"name":"dataType","url":"interfaces/field.html#datatype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":447,"kind":1024,"name":"role","url":"interfaces/field.html#role","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":448,"kind":1024,"name":"aggregation","url":"interfaces/field.html#aggregation","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":449,"kind":1024,"name":"columnType","url":"interfaces/field.html#columntype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":450,"kind":1024,"name":"isCalculatedField","url":"interfaces/field.html#iscalculatedfield","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":451,"kind":1024,"name":"isCombinedField","url":"interfaces/field.html#iscombinedfield","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":452,"kind":1024,"name":"isGenerated","url":"interfaces/field.html#isgenerated","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":453,"kind":1024,"name":"isGeospatial","url":"interfaces/field.html#isgeospatial","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":454,"kind":1024,"name":"isHidden","url":"interfaces/field.html#ishidden","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":455,"kind":1024,"name":"isPresentOnPublishedDatasource","url":"interfaces/field.html#ispresentonpublisheddatasource","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"Field"},{"id":456,"kind":256,"name":"ConnectionSummary","url":"interfaces/connectionsummary.html","classes":"tsd-kind-interface"},{"id":457,"kind":1024,"name":"name","url":"interfaces/connectionsummary.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ConnectionSummary"},{"id":458,"kind":1024,"name":"id","url":"interfaces/connectionsummary.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ConnectionSummary"},{"id":459,"kind":1024,"name":"type","url":"interfaces/connectionsummary.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ConnectionSummary"},{"id":460,"kind":1024,"name":"serverURI","url":"interfaces/connectionsummary.html#serveruri","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"ConnectionSummary"},{"id":461,"kind":256,"name":"TableSummary","url":"interfaces/tablesummary.html","classes":"tsd-kind-interface"},{"id":462,"kind":1024,"name":"name","url":"interfaces/tablesummary.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableSummary"},{"id":463,"kind":1024,"name":"id","url":"interfaces/tablesummary.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableSummary"},{"id":464,"kind":1024,"name":"connectionId","url":"interfaces/tablesummary.html#connectionid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableSummary"},{"id":465,"kind":1024,"name":"customSQL","url":"interfaces/tablesummary.html#customsql","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableSummary"},{"id":466,"kind":256,"name":"DataSourceUnderlyingDataOptions","url":"interfaces/datasourceunderlyingdataoptions.html","classes":"tsd-kind-interface"},{"id":467,"kind":1024,"name":"ignoreAliases","url":"interfaces/datasourceunderlyingdataoptions.html#ignorealiases","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSourceUnderlyingDataOptions"},{"id":468,"kind":1024,"name":"columnsToInclude","url":"interfaces/datasourceunderlyingdataoptions.html#columnstoinclude","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSourceUnderlyingDataOptions"},{"id":469,"kind":1024,"name":"columnsToIncludeById","url":"interfaces/datasourceunderlyingdataoptions.html#columnstoincludebyid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSourceUnderlyingDataOptions"},{"id":470,"kind":1024,"name":"maxRows","url":"interfaces/datasourceunderlyingdataoptions.html#maxrows","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSourceUnderlyingDataOptions"},{"id":471,"kind":1024,"name":"includeDataValuesOption","url":"interfaces/datasourceunderlyingdataoptions.html#includedatavaluesoption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DataSourceUnderlyingDataOptions"},{"id":472,"kind":256,"name":"LogicalTable","url":"interfaces/logicaltable.html","classes":"tsd-kind-interface"},{"id":473,"kind":1024,"name":"id","url":"interfaces/logicaltable.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LogicalTable"},{"id":474,"kind":1024,"name":"caption","url":"interfaces/logicaltable.html#caption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"LogicalTable"},{"id":475,"kind":256,"name":"Filter","url":"interfaces/filter.html","classes":"tsd-kind-interface"},{"id":476,"kind":1024,"name":"worksheetName","url":"interfaces/filter.html#worksheetname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Filter"},{"id":477,"kind":1024,"name":"filterType","url":"interfaces/filter.html#filtertype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Filter"},{"id":478,"kind":1024,"name":"fieldName","url":"interfaces/filter.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Filter"},{"id":479,"kind":1024,"name":"fieldId","url":"interfaces/filter.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Filter"},{"id":480,"kind":2048,"name":"getFieldAsync","url":"interfaces/filter.html#getfieldasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Filter"},{"id":481,"kind":2048,"name":"getAppliedWorksheetsAsync","url":"interfaces/filter.html#getappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Filter"},{"id":482,"kind":2048,"name":"setAppliedWorksheetsAsync","url":"interfaces/filter.html#setappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Filter"},{"id":483,"kind":256,"name":"CategoricalFilter","url":"interfaces/categoricalfilter.html","classes":"tsd-kind-interface"},{"id":484,"kind":1024,"name":"isAllSelected","url":"interfaces/categoricalfilter.html#isallselected","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"CategoricalFilter"},{"id":485,"kind":1024,"name":"appliedValues","url":"interfaces/categoricalfilter.html#appliedvalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"CategoricalFilter"},{"id":486,"kind":1024,"name":"isExcludeMode","url":"interfaces/categoricalfilter.html#isexcludemode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"CategoricalFilter"},{"id":487,"kind":2048,"name":"getDomainAsync","url":"interfaces/categoricalfilter.html#getdomainasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"CategoricalFilter"},{"id":488,"kind":1024,"name":"worksheetName","url":"interfaces/categoricalfilter.html#worksheetname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":489,"kind":1024,"name":"filterType","url":"interfaces/categoricalfilter.html#filtertype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":490,"kind":1024,"name":"fieldName","url":"interfaces/categoricalfilter.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":491,"kind":1024,"name":"fieldId","url":"interfaces/categoricalfilter.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":492,"kind":2048,"name":"getFieldAsync","url":"interfaces/categoricalfilter.html#getfieldasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":493,"kind":2048,"name":"getAppliedWorksheetsAsync","url":"interfaces/categoricalfilter.html#getappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":494,"kind":2048,"name":"setAppliedWorksheetsAsync","url":"interfaces/categoricalfilter.html#setappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"CategoricalFilter"},{"id":495,"kind":256,"name":"HierarchicalFilter","url":"interfaces/hierarchicalfilter.html","classes":"tsd-kind-interface"},{"id":496,"kind":1024,"name":"dimensionName","url":"interfaces/hierarchicalfilter.html#dimensionname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":497,"kind":1024,"name":"hierarchyCaption","url":"interfaces/hierarchicalfilter.html#hierarchycaption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":498,"kind":1024,"name":"numberOfLevels","url":"interfaces/hierarchicalfilter.html#numberoflevels","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":499,"kind":1024,"name":"levelDetails","url":"interfaces/hierarchicalfilter.html#leveldetails","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":500,"kind":1024,"name":"isAllSelected","url":"interfaces/hierarchicalfilter.html#isallselected","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":501,"kind":1024,"name":"appliedValues","url":"interfaces/hierarchicalfilter.html#appliedvalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilter"},{"id":502,"kind":1024,"name":"worksheetName","url":"interfaces/hierarchicalfilter.html#worksheetname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":503,"kind":1024,"name":"filterType","url":"interfaces/hierarchicalfilter.html#filtertype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":504,"kind":1024,"name":"fieldName","url":"interfaces/hierarchicalfilter.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":505,"kind":1024,"name":"fieldId","url":"interfaces/hierarchicalfilter.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":506,"kind":2048,"name":"getFieldAsync","url":"interfaces/hierarchicalfilter.html#getfieldasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":507,"kind":2048,"name":"getAppliedWorksheetsAsync","url":"interfaces/hierarchicalfilter.html#getappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":508,"kind":2048,"name":"setAppliedWorksheetsAsync","url":"interfaces/hierarchicalfilter.html#setappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"HierarchicalFilter"},{"id":509,"kind":256,"name":"RangeFilter","url":"interfaces/rangefilter.html","classes":"tsd-kind-interface"},{"id":510,"kind":1024,"name":"minValue","url":"interfaces/rangefilter.html#minvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilter"},{"id":511,"kind":1024,"name":"maxValue","url":"interfaces/rangefilter.html#maxvalue","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilter"},{"id":512,"kind":1024,"name":"includeNullValues","url":"interfaces/rangefilter.html#includenullvalues","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilter"},{"id":513,"kind":2048,"name":"getDomainAsync","url":"interfaces/rangefilter.html#getdomainasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"RangeFilter"},{"id":514,"kind":1024,"name":"worksheetName","url":"interfaces/rangefilter.html#worksheetname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":515,"kind":1024,"name":"filterType","url":"interfaces/rangefilter.html#filtertype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":516,"kind":1024,"name":"fieldName","url":"interfaces/rangefilter.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":517,"kind":1024,"name":"fieldId","url":"interfaces/rangefilter.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":518,"kind":2048,"name":"getFieldAsync","url":"interfaces/rangefilter.html#getfieldasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":519,"kind":2048,"name":"getAppliedWorksheetsAsync","url":"interfaces/rangefilter.html#getappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":520,"kind":2048,"name":"setAppliedWorksheetsAsync","url":"interfaces/rangefilter.html#setappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RangeFilter"},{"id":521,"kind":256,"name":"RelativeDateFilter","url":"interfaces/relativedatefilter.html","classes":"tsd-kind-interface"},{"id":522,"kind":1024,"name":"anchorDate","url":"interfaces/relativedatefilter.html#anchordate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilter"},{"id":523,"kind":1024,"name":"periodType","url":"interfaces/relativedatefilter.html#periodtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilter"},{"id":524,"kind":1024,"name":"rangeType","url":"interfaces/relativedatefilter.html#rangetype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilter"},{"id":525,"kind":1024,"name":"rangeN","url":"interfaces/relativedatefilter.html#rangen","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilter"},{"id":526,"kind":1024,"name":"worksheetName","url":"interfaces/relativedatefilter.html#worksheetname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":527,"kind":1024,"name":"filterType","url":"interfaces/relativedatefilter.html#filtertype","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":528,"kind":1024,"name":"fieldName","url":"interfaces/relativedatefilter.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":529,"kind":1024,"name":"fieldId","url":"interfaces/relativedatefilter.html#fieldid","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":530,"kind":2048,"name":"getFieldAsync","url":"interfaces/relativedatefilter.html#getfieldasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":531,"kind":2048,"name":"getAppliedWorksheetsAsync","url":"interfaces/relativedatefilter.html#getappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":532,"kind":2048,"name":"setAppliedWorksheetsAsync","url":"interfaces/relativedatefilter.html#setappliedworksheetsasync","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"RelativeDateFilter"},{"id":533,"kind":256,"name":"FilterOptions","url":"interfaces/filteroptions.html","classes":"tsd-kind-interface"},{"id":534,"kind":1024,"name":"isExcludeMode","url":"interfaces/filteroptions.html#isexcludemode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FilterOptions"},{"id":535,"kind":256,"name":"RangeFilterOptions","url":"interfaces/rangefilteroptions.html","classes":"tsd-kind-interface"},{"id":536,"kind":1024,"name":"min","url":"interfaces/rangefilteroptions.html#min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilterOptions"},{"id":537,"kind":1024,"name":"max","url":"interfaces/rangefilteroptions.html#max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilterOptions"},{"id":538,"kind":1024,"name":"nullOption","url":"interfaces/rangefilteroptions.html#nulloption","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeFilterOptions"},{"id":539,"kind":256,"name":"RelativeDateFilterOptions","url":"interfaces/relativedatefilteroptions.html","classes":"tsd-kind-interface"},{"id":540,"kind":1024,"name":"anchorDate","url":"interfaces/relativedatefilteroptions.html#anchordate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilterOptions"},{"id":541,"kind":1024,"name":"periodType","url":"interfaces/relativedatefilteroptions.html#periodtype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilterOptions"},{"id":542,"kind":1024,"name":"rangeType","url":"interfaces/relativedatefilteroptions.html#rangetype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilterOptions"},{"id":543,"kind":1024,"name":"rangeN","url":"interfaces/relativedatefilteroptions.html#rangen","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RelativeDateFilterOptions"},{"id":544,"kind":256,"name":"RangeDomain","url":"interfaces/rangedomain.html","classes":"tsd-kind-interface"},{"id":545,"kind":1024,"name":"type","url":"interfaces/rangedomain.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeDomain"},{"id":546,"kind":1024,"name":"min","url":"interfaces/rangedomain.html#min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeDomain"},{"id":547,"kind":1024,"name":"max","url":"interfaces/rangedomain.html#max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RangeDomain"},{"id":548,"kind":256,"name":"CategoricalDomain","url":"interfaces/categoricaldomain.html","classes":"tsd-kind-interface"},{"id":549,"kind":1024,"name":"type","url":"interfaces/categoricaldomain.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"CategoricalDomain"},{"id":550,"kind":1024,"name":"values","url":"interfaces/categoricaldomain.html#values","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"CategoricalDomain"},{"id":551,"kind":256,"name":"HierarchicalFilterDataValue","url":"interfaces/hierarchicalfilterdatavalue.html","classes":"tsd-kind-interface"},{"id":552,"kind":1024,"name":"value","url":"interfaces/hierarchicalfilterdatavalue.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilterDataValue"},{"id":553,"kind":1024,"name":"hierarchicalPath","url":"interfaces/hierarchicalfilterdatavalue.html#hierarchicalpath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilterDataValue"},{"id":554,"kind":1024,"name":"level","url":"interfaces/hierarchicalfilterdatavalue.html#level","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalFilterDataValue"},{"id":555,"kind":256,"name":"HierarchicalLevelDetail","url":"interfaces/hierarchicalleveldetail.html","classes":"tsd-kind-interface"},{"id":556,"kind":1024,"name":"name","url":"interfaces/hierarchicalleveldetail.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalLevelDetail"},{"id":557,"kind":1024,"name":"levelSelectionState","url":"interfaces/hierarchicalleveldetail.html#levelselectionstate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"HierarchicalLevelDetail"},{"id":558,"kind":256,"name":"Workbook","url":"interfaces/workbook.html","classes":"tsd-kind-interface"},{"id":559,"kind":2048,"name":"getAllDataSourcesAsync","url":"interfaces/workbook.html#getalldatasourcesasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Workbook"},{"id":560,"kind":256,"name":"DashboardContent","url":"interfaces/dashboardcontent.html","classes":"tsd-kind-interface"},{"id":561,"kind":1024,"name":"dashboard","url":"interfaces/dashboardcontent.html#dashboard","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardContent"},{"id":562,"kind":256,"name":"Environment","url":"interfaces/environment.html","classes":"tsd-kind-interface"},{"id":563,"kind":1024,"name":"apiVersion","url":"interfaces/environment.html#apiversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":564,"kind":1024,"name":"context","url":"interfaces/environment.html#context","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":565,"kind":1024,"name":"language","url":"interfaces/environment.html#language","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":566,"kind":1024,"name":"country","url":"interfaces/environment.html#country","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":567,"kind":1024,"name":"workbookFormatting","url":"interfaces/environment.html#workbookformatting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":568,"kind":1024,"name":"locale","url":"interfaces/environment.html#locale","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":569,"kind":1024,"name":"mode","url":"interfaces/environment.html#mode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":570,"kind":1024,"name":"operatingSystem","url":"interfaces/environment.html#operatingsystem","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":571,"kind":1024,"name":"tableauVersion","url":"interfaces/environment.html#tableauversion","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":572,"kind":1024,"name":"uniqueUserId","url":"interfaces/environment.html#uniqueuserid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Environment"},{"id":573,"kind":256,"name":"Settings","url":"interfaces/settings.html","classes":"tsd-kind-interface"},{"id":574,"kind":2048,"name":"erase","url":"interfaces/settings.html#erase","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Settings"},{"id":575,"kind":2048,"name":"get","url":"interfaces/settings.html#get","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Settings"},{"id":576,"kind":2048,"name":"getAll","url":"interfaces/settings.html#getall","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Settings"},{"id":577,"kind":1024,"name":"isModified","url":"interfaces/settings.html#ismodified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Settings"},{"id":578,"kind":2048,"name":"saveAsync","url":"interfaces/settings.html#saveasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Settings"},{"id":579,"kind":2048,"name":"set","url":"interfaces/settings.html#set","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Settings"},{"id":580,"kind":2048,"name":"addEventListener","url":"interfaces/settings.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Settings"},{"id":581,"kind":2048,"name":"removeEventListener","url":"interfaces/settings.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited","parent":"Settings"},{"id":582,"kind":256,"name":"UI","url":"interfaces/ui.html","classes":"tsd-kind-interface"},{"id":583,"kind":2048,"name":"displayDialogAsync","url":"interfaces/ui.html#displaydialogasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"UI"},{"id":584,"kind":2048,"name":"sendDialogMessageAsync","url":"interfaces/ui.html#senddialogmessageasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"UI"},{"id":585,"kind":2048,"name":"sendDialogMessageToParentAsync","url":"interfaces/ui.html#senddialogmessagetoparentasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"UI"},{"id":586,"kind":2048,"name":"closeDialog","url":"interfaces/ui.html#closedialog","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"UI"},{"id":587,"kind":256,"name":"DialogOptions","url":"interfaces/dialogoptions.html","classes":"tsd-kind-interface"},{"id":588,"kind":1024,"name":"width","url":"interfaces/dialogoptions.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DialogOptions"},{"id":589,"kind":1024,"name":"height","url":"interfaces/dialogoptions.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DialogOptions"},{"id":590,"kind":1024,"name":"dialogStyle","url":"interfaces/dialogoptions.html#dialogstyle","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DialogOptions"},{"id":591,"kind":256,"name":"WorksheetContent","url":"interfaces/worksheetcontent.html","classes":"tsd-kind-interface"},{"id":592,"kind":1024,"name":"worksheet","url":"interfaces/worksheetcontent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorksheetContent"},{"id":593,"kind":256,"name":"Extensions","url":"interfaces/extensions.html","classes":"tsd-kind-interface"},{"id":594,"kind":2048,"name":"initializeAsync","url":"interfaces/extensions.html#initializeasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Extensions"},{"id":595,"kind":2048,"name":"initializeDialogAsync","url":"interfaces/extensions.html#initializedialogasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Extensions"},{"id":596,"kind":1024,"name":"dashboardContent","url":"interfaces/extensions.html#dashboardcontent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":597,"kind":1024,"name":"worksheetContent","url":"interfaces/extensions.html#worksheetcontent","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":598,"kind":1024,"name":"environment","url":"interfaces/extensions.html#environment","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":599,"kind":1024,"name":"settings","url":"interfaces/extensions.html#settings","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":600,"kind":1024,"name":"ui","url":"interfaces/extensions.html#ui","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":601,"kind":1024,"name":"workbook","url":"interfaces/extensions.html#workbook","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":602,"kind":1024,"name":"dashboardObjectId","url":"interfaces/extensions.html#dashboardobjectid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"Extensions"},{"id":603,"kind":2048,"name":"createVizImageAsync","url":"interfaces/extensions.html#createvizimageasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Extensions"},{"id":604,"kind":2048,"name":"setClickThroughAsync","url":"interfaces/extensions.html#setclickthroughasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"Extensions"},{"id":605,"kind":4,"name":"ErrorCodes","url":"enums/tableau.errorcodes.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":606,"kind":16,"name":"APINotInitialized","url":"enums/tableau.errorcodes.html#apinotinitialized","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":607,"kind":16,"name":"VisibilityError","url":"enums/tableau.errorcodes.html#visibilityerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":608,"kind":16,"name":"DialogAlreadyOpen","url":"enums/tableau.errorcodes.html#dialogalreadyopen","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":609,"kind":16,"name":"DialogClosedByUser","url":"enums/tableau.errorcodes.html#dialogclosedbyuser","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":610,"kind":16,"name":"InternalError","url":"enums/tableau.errorcodes.html#internalerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":611,"kind":16,"name":"InvalidDomainDialog","url":"enums/tableau.errorcodes.html#invaliddomaindialog","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":612,"kind":16,"name":"InvalidParameter","url":"enums/tableau.errorcodes.html#invalidparameter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":613,"kind":16,"name":"MissingFilter","url":"enums/tableau.errorcodes.html#missingfilter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":614,"kind":16,"name":"MissingParameter","url":"enums/tableau.errorcodes.html#missingparameter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":615,"kind":16,"name":"ServerError","url":"enums/tableau.errorcodes.html#servererror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":616,"kind":16,"name":"SettingSaveInProgress","url":"enums/tableau.errorcodes.html#settingsaveinprogress","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":617,"kind":16,"name":"UnsupportedEventName","url":"enums/tableau.errorcodes.html#unsupportedeventname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":618,"kind":16,"name":"UnsupportedMethodForDataSourceType","url":"enums/tableau.errorcodes.html#unsupportedmethodfordatasourcetype","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ErrorCodes"},{"id":619,"kind":4,"name":"ExtensionContext","url":"enums/tableau.extensioncontext.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":620,"kind":16,"name":"Desktop","url":"enums/tableau.extensioncontext.html#desktop","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionContext"},{"id":621,"kind":16,"name":"Server","url":"enums/tableau.extensioncontext.html#server","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionContext"},{"id":622,"kind":16,"name":"Cloud","url":"enums/tableau.extensioncontext.html#cloud","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionContext"},{"id":623,"kind":16,"name":"PublicWeb","url":"enums/tableau.extensioncontext.html#publicweb","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionContext"},{"id":624,"kind":16,"name":"PublicDesktop","url":"enums/tableau.extensioncontext.html#publicdesktop","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionContext"},{"id":625,"kind":4,"name":"ExtensionMode","url":"enums/tableau.extensionmode.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":626,"kind":16,"name":"Authoring","url":"enums/tableau.extensionmode.html#authoring","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionMode"},{"id":627,"kind":16,"name":"Viewing","url":"enums/tableau.extensionmode.html#viewing","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.ExtensionMode"},{"id":628,"kind":4,"name":"TableauEventType","url":"enums/tableau.tableaueventtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":629,"kind":16,"name":"DialogMessageReceived","url":"enums/tableau.tableaueventtype.html#dialogmessagereceived","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":630,"kind":16,"name":"FilterChanged","url":"enums/tableau.tableaueventtype.html#filterchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":631,"kind":16,"name":"MarkSelectionChanged","url":"enums/tableau.tableaueventtype.html#markselectionchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":632,"kind":16,"name":"SummaryDataChanged","url":"enums/tableau.tableaueventtype.html#summarydatachanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":633,"kind":16,"name":"ParameterChanged","url":"enums/tableau.tableaueventtype.html#parameterchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":634,"kind":16,"name":"SettingsChanged","url":"enums/tableau.tableaueventtype.html#settingschanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":635,"kind":16,"name":"DashboardLayoutChanged","url":"enums/tableau.tableaueventtype.html#dashboardlayoutchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":636,"kind":16,"name":"WorkbookFormattingChanged","url":"enums/tableau.tableaueventtype.html#workbookformattingchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":637,"kind":16,"name":"WorksheetFormattingChanged","url":"enums/tableau.tableaueventtype.html#worksheetformattingchanged","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.TableauEventType"},{"id":638,"kind":4,"name":"VizImageEncodingType","url":"enums/tableau.vizimageencodingtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":639,"kind":16,"name":"Discrete","url":"enums/tableau.vizimageencodingtype.html#discrete","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageEncodingType"},{"id":640,"kind":16,"name":"Continuous","url":"enums/tableau.vizimageencodingtype.html#continuous","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageEncodingType"},{"id":641,"kind":4,"name":"VizImageSortDirectionType","url":"enums/tableau.vizimagesortdirectiontype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":642,"kind":16,"name":"Ascending","url":"enums/tableau.vizimagesortdirectiontype.html#ascending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSortDirectionType"},{"id":643,"kind":16,"name":"Descending","url":"enums/tableau.vizimagesortdirectiontype.html#descending","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSortDirectionType"},{"id":644,"kind":4,"name":"VizImagePaletteType","url":"enums/tableau.vizimagepalettetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":645,"kind":16,"name":"CustomDiverging","url":"enums/tableau.vizimagepalettetype.html#customdiverging","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImagePaletteType"},{"id":646,"kind":16,"name":"CustomSequential","url":"enums/tableau.vizimagepalettetype.html#customsequential","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImagePaletteType"},{"id":647,"kind":4,"name":"VizImageSizeSettingType","url":"enums/tableau.vizimagesizesettingtype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":648,"kind":16,"name":"Fixed","url":"enums/tableau.vizimagesizesettingtype.html#fixed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSizeSettingType"},{"id":649,"kind":16,"name":"Manual","url":"enums/tableau.vizimagesizesettingtype.html#manual","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSizeSettingType"},{"id":650,"kind":4,"name":"VizImageSizeSettingAlignmentType","url":"enums/tableau.vizimagesizesettingalignmenttype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"Tableau"},{"id":651,"kind":16,"name":"Right","url":"enums/tableau.vizimagesizesettingalignmenttype.html#right","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSizeSettingAlignmentType"},{"id":652,"kind":16,"name":"Left","url":"enums/tableau.vizimagesizesettingalignmenttype.html#left","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSizeSettingAlignmentType"},{"id":653,"kind":16,"name":"Center","url":"enums/tableau.vizimagesizesettingalignmenttype.html#center","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Tableau.VizImageSizeSettingAlignmentType"},{"id":654,"kind":32,"name":"extensions","url":"modules/tableau.html#extensions","classes":"tsd-kind-variable tsd-parent-kind-module","parent":"Tableau"},{"id":655,"kind":256,"name":"TableauWorksheetEvent","url":"interfaces/tableauworksheetevent.html","classes":"tsd-kind-interface"},{"id":656,"kind":1024,"name":"worksheet","url":"interfaces/tableauworksheetevent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableauWorksheetEvent"},{"id":657,"kind":1024,"name":"sheet","url":"interfaces/tableauworksheetevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauWorksheetEvent"},{"id":658,"kind":1024,"name":"type","url":"interfaces/tableauworksheetevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauWorksheetEvent"},{"id":659,"kind":256,"name":"MarksSelectedEvent","url":"interfaces/marksselectedevent.html","classes":"tsd-kind-interface"},{"id":660,"kind":2048,"name":"getMarksAsync","url":"interfaces/marksselectedevent.html#getmarksasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"MarksSelectedEvent"},{"id":661,"kind":1024,"name":"worksheet","url":"interfaces/marksselectedevent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"MarksSelectedEvent"},{"id":662,"kind":1024,"name":"sheet","url":"interfaces/marksselectedevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"MarksSelectedEvent"},{"id":663,"kind":1024,"name":"type","url":"interfaces/marksselectedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"MarksSelectedEvent"},{"id":664,"kind":256,"name":"SummaryDataChangedEvent","url":"interfaces/summarydatachangedevent.html","classes":"tsd-kind-interface"},{"id":665,"kind":1024,"name":"worksheet","url":"interfaces/summarydatachangedevent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SummaryDataChangedEvent"},{"id":666,"kind":1024,"name":"sheet","url":"interfaces/summarydatachangedevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SummaryDataChangedEvent"},{"id":667,"kind":1024,"name":"type","url":"interfaces/summarydatachangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SummaryDataChangedEvent"},{"id":668,"kind":256,"name":"TableauSheetEvent","url":"interfaces/tableausheetevent.html","classes":"tsd-kind-interface"},{"id":669,"kind":1024,"name":"sheet","url":"interfaces/tableausheetevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableauSheetEvent"},{"id":670,"kind":1024,"name":"type","url":"interfaces/tableausheetevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauSheetEvent"},{"id":671,"kind":256,"name":"FilterChangedEvent","url":"interfaces/filterchangedevent.html","classes":"tsd-kind-interface"},{"id":672,"kind":1024,"name":"fieldName","url":"interfaces/filterchangedevent.html#fieldname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"FilterChangedEvent"},{"id":673,"kind":2048,"name":"getFilterAsync","url":"interfaces/filterchangedevent.html#getfilterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"FilterChangedEvent"},{"id":674,"kind":1024,"name":"worksheet","url":"interfaces/filterchangedevent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FilterChangedEvent"},{"id":675,"kind":1024,"name":"sheet","url":"interfaces/filterchangedevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FilterChangedEvent"},{"id":676,"kind":1024,"name":"type","url":"interfaces/filterchangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"FilterChangedEvent"},{"id":677,"kind":256,"name":"WorkbookFormattingChangedEvent","url":"interfaces/workbookformattingchangedevent.html","classes":"tsd-kind-interface"},{"id":678,"kind":1024,"name":"formatting","url":"interfaces/workbookformattingchangedevent.html#formatting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorkbookFormattingChangedEvent"},{"id":679,"kind":1024,"name":"type","url":"interfaces/workbookformattingchangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"WorkbookFormattingChangedEvent"},{"id":680,"kind":256,"name":"WorksheetFormattingChangedEvent","url":"interfaces/worksheetformattingchangedevent.html","classes":"tsd-kind-interface"},{"id":681,"kind":1024,"name":"formatting","url":"interfaces/worksheetformattingchangedevent.html#formatting","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"WorksheetFormattingChangedEvent"},{"id":682,"kind":1024,"name":"worksheet","url":"interfaces/worksheetformattingchangedevent.html#worksheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"WorksheetFormattingChangedEvent"},{"id":683,"kind":1024,"name":"sheet","url":"interfaces/worksheetformattingchangedevent.html#sheet","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"WorksheetFormattingChangedEvent"},{"id":684,"kind":1024,"name":"type","url":"interfaces/worksheetformattingchangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"WorksheetFormattingChangedEvent"},{"id":685,"kind":256,"name":"TableauEvent","url":"interfaces/tableauevent.html","classes":"tsd-kind-interface"},{"id":686,"kind":1024,"name":"type","url":"interfaces/tableauevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableauEvent"},{"id":687,"kind":256,"name":"ParameterChangedEvent","url":"interfaces/parameterchangedevent.html","classes":"tsd-kind-interface"},{"id":688,"kind":2048,"name":"getParameterAsync","url":"interfaces/parameterchangedevent.html#getparameterasync","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"ParameterChangedEvent"},{"id":689,"kind":1024,"name":"type","url":"interfaces/parameterchangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"ParameterChangedEvent"},{"id":690,"kind":256,"name":"SettingsChangedEvent","url":"interfaces/settingschangedevent.html","classes":"tsd-kind-interface"},{"id":691,"kind":1024,"name":"newSettings","url":"interfaces/settingschangedevent.html#newsettings","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SettingsChangedEvent"},{"id":692,"kind":65536,"name":"__type","url":"interfaces/settingschangedevent.html#newsettings.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"SettingsChangedEvent.newSettings"},{"id":693,"kind":1024,"name":"type","url":"interfaces/settingschangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SettingsChangedEvent"},{"id":694,"kind":256,"name":"DashboardLayoutChangedEvent","url":"interfaces/dashboardlayoutchangedevent.html","classes":"tsd-kind-interface"},{"id":695,"kind":1024,"name":"dashboardLayoutChangeDetails","url":"interfaces/dashboardlayoutchangedevent.html#dashboardlayoutchangedetails","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DashboardLayoutChangedEvent"},{"id":696,"kind":1024,"name":"type","url":"interfaces/dashboardlayoutchangedevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DashboardLayoutChangedEvent"},{"id":697,"kind":256,"name":"DialogMessageEvent","url":"interfaces/dialogmessageevent.html","classes":"tsd-kind-interface"},{"id":698,"kind":1024,"name":"message","url":"interfaces/dialogmessageevent.html#message","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DialogMessageEvent"},{"id":699,"kind":1024,"name":"sourceDialogUrl","url":"interfaces/dialogmessageevent.html#sourcedialogurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"DialogMessageEvent"},{"id":700,"kind":1024,"name":"type","url":"interfaces/dialogmessageevent.html#type","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"DialogMessageEvent"},{"id":701,"kind":256,"name":"EventListenerManager","url":"interfaces/eventlistenermanager.html","classes":"tsd-kind-interface"},{"id":702,"kind":2048,"name":"addEventListener","url":"interfaces/eventlistenermanager.html#addeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"EventListenerManager"},{"id":703,"kind":2048,"name":"removeEventListener","url":"interfaces/eventlistenermanager.html#removeeventlistener","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"EventListenerManager"},{"id":704,"kind":4194304,"name":"DashboardLayoutChangeDetails","url":"globals.html#dashboardlayoutchangedetails","classes":"tsd-kind-type-alias"},{"id":705,"kind":4194304,"name":"TableauEventHandlerFn","url":"globals.html#tableaueventhandlerfn","classes":"tsd-kind-type-alias"},{"id":706,"kind":65536,"name":"__type","url":"globals.html#tableaueventhandlerfn.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"TableauEventHandlerFn"},{"id":707,"kind":4194304,"name":"TableauEventUnregisterFn","url":"globals.html#tableaueventunregisterfn","classes":"tsd-kind-type-alias"},{"id":708,"kind":65536,"name":"__type","url":"globals.html#tableaueventunregisterfn.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"TableauEventUnregisterFn"},{"id":709,"kind":256,"name":"TableauError","url":"interfaces/tableauerror.html","classes":"tsd-kind-interface"},{"id":710,"kind":1024,"name":"errorCode","url":"interfaces/tableauerror.html#errorcode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableauError"},{"id":711,"kind":1024,"name":"name","url":"interfaces/tableauerror.html#name","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauError"},{"id":712,"kind":1024,"name":"message","url":"interfaces/tableauerror.html#message","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauError"},{"id":713,"kind":1024,"name":"stack","url":"interfaces/tableauerror.html#stack","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"TableauError"},{"id":714,"kind":1024,"name":"Error","url":"interfaces/tableauerror.html#error","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TableauError"},{"id":715,"kind":4,"name":"SharedErrorCodes","url":"enums/sharederrorcodes.html","classes":"tsd-kind-enum"},{"id":716,"kind":16,"name":"CrosstabCreationError","url":"enums/sharederrorcodes.html#crosstabcreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":717,"kind":16,"name":"DataCreationError","url":"enums/sharederrorcodes.html#datacreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":718,"kind":16,"name":"InvalidAggregationFieldName","url":"enums/sharederrorcodes.html#invalidaggregationfieldname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":719,"kind":16,"name":"InvalidFilterFieldName","url":"enums/sharederrorcodes.html#invalidfilterfieldname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":720,"kind":16,"name":"InvalidFilterFieldValue","url":"enums/sharederrorcodes.html#invalidfilterfieldvalue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":721,"kind":16,"name":"InvalidSelectionDate","url":"enums/sharederrorcodes.html#invalidselectiondate","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":722,"kind":16,"name":"InvalidSelectionFieldName","url":"enums/sharederrorcodes.html#invalidselectionfieldname","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":723,"kind":16,"name":"InvalidSelectionValue","url":"enums/sharederrorcodes.html#invalidselectionvalue","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":724,"kind":16,"name":"InvalidSelectionSheet","url":"enums/sharederrorcodes.html#invalidselectionsheet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":725,"kind":16,"name":"InternalError","url":"enums/sharederrorcodes.html#internalerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":726,"kind":16,"name":"InvalidParameter","url":"enums/sharederrorcodes.html#invalidparameter","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":727,"kind":16,"name":"PDFCreationError","url":"enums/sharederrorcodes.html#pdfcreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":728,"kind":16,"name":"PowerPointCreationError","url":"enums/sharederrorcodes.html#powerpointcreationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":729,"kind":16,"name":"NotActiveSheet","url":"enums/sharederrorcodes.html#notactivesheet","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":730,"kind":16,"name":"ImplementationError","url":"enums/sharederrorcodes.html#implementationerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":731,"kind":16,"name":"ApiExecutionError","url":"enums/sharederrorcodes.html#apiexecutionerror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":732,"kind":16,"name":"ServerError","url":"enums/sharederrorcodes.html#servererror","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"},{"id":733,"kind":16,"name":"Timeout","url":"enums/sharederrorcodes.html#timeout","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SharedErrorCodes"}]}; \ No newline at end of file diff --git a/website/static/api/assets/main.js b/website/static/api/assets/main.js new file mode 100644 index 00000000..19bbb7a7 --- /dev/null +++ b/website/static/api/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
    ${e}
    `:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/website/static/api/assets/navigation.js b/website/static/api/assets/navigation.js new file mode 100644 index 00000000..e04f0cfe --- /dev/null +++ b/website/static/api/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "eJytmttu4zYQht9F10EPKbaH3AXOpms0yabxOgW62AtamshsKNKgqGCVYt+9kBTJlDgzpIHe+v/nG4oUOSTlz/9mDr667CK71EK1Tub1x90/kLtP7QGys+wg3D67yEA3Vf09Yvlu7yqVnWXPUhfZxa/fzjyeNk44aTSO8lWaslKiru9EBX9Au2T4GkMwqqnQNhwVOvpK1PudEba4Ea1p3GovdBmAUFMCk+5pxJLMe5S13EklXZtAnpu5HE5cG1sJorm+ylOo+GgkPHTdSoQfRYYhhTLlxrUqJBwlOv69zk0hdYk1wdcYgrXGrkwBdRA/KUz0Vwe6lkavjO5/WjIWegLp1hTho/gizbiWoIrLsrRQkrMc80SID0ahYzwTOYZyYK9MJSTRorkeI901Sn08dG3HSUc9RqJbk9KO7aEQjuiYuU6TPkiwwuZ7mQt1Ay+gNqAg79q+ccIF4IidzrPWuWoK6Cb1o1AN1HgHEjaaeyvsM9YD4+905F3//r3AXVPtwA4r1ZKCeRii59pq6YIJHRho1r2wogIHtu8G7AlDB0MDK02BUiaFjv6zkfnzJ7FTsBIqxyihg6Y9wEGJdnMAQBu0kGnO9ObR0wCxxHjD+xaM3ExkGHthoaBX9KXOkQDQsjoJTKyx7kra4dGDeF+kGf1giub9C2i0GUudIVnQxY3U0JUOhbICB017lK/rSpTA1V3MEyfeCwUOf48QS5y3ka+wAeekLi+VLHVF9GTMf1KmxASJXP9VYclLY8oJ4AiT2oF9Ejn4R4A54vzdz/72XTgoje2K0FC1UVbgSkQOxTOGHFwssj9K4Jxe4oO1fiusTVUJ2xKchYtDTrt8FDWpSYh+N6kdT3ozJQH9U1LRryo8O/QnpRkOODx68JyAuze17MbgUhfdHBuKTUoONJBPPJ6pulkc1KpZJsQZQ29MY3Oq5aOcBtnqAqxqpS6732ItZWJi6fpCRIJ7NQnxAKIgZv3CE8P1+zES1Kssoj923kJddyWMngmBLQ5lh8F3cKixqqKUUeQBL9Kavr4RjElnMd0z38jagQZ7K7QoieHDjCx4POviHXWUOUh/NEXjeyUauta1E5qYjDMHjyJLWbx+DY7okhza4lDuRZw5WNS0vPV7Yhw293C438G9FdHYioU6I+j09ZAycwn8Yzkz5qHtNCi/ujH+1DT9lcIVOCFVNIXnPQmP93po46A3puyMdO3xDRyou6ZY6yeDQkYxBqhXRqnlaW/B8TxR3HDY5eZ8aItDD5DLJ5nTe//QxkGn6w+UNalJiOgahzqT0MPJ4wFqZyU9QrSdTWIk1d5O4UL7m3Hm7OTpUQyz4Hh6IoZbGUNbFEqvVkeZhYDqLwC7rwnccwa206DsU1NuLsV087Wy0oGVAkUHLh7Z11G8kaOYAojONszIgsnyHy363bELj5Sv7IvhbQDiz4N7Ofx4vdbdFKJM35ACIhvnGxJAfY9GaUdXAvIvY5/rJOzcGUVzNye+gQUZo5w8BF/XfNTMwsG2axSwXXNBj7JuhIqXT8THYbu+3BnzjLJGMQVw3GKzqKPtNGh0dvEhsWQ1uXZMahKCuxBbmpKACd268J2ITepYJibxNnVRgV17mN+jYiX4h99++fHdeeyacNj710s2503Ow9zPXVorWjJpLPDEFhz/inErDpGkM288z3g/GFJHJcbwS8cHoQsF9lovcajpFPJWWyi725sI3PfF+H8bDWzXBgaUeJbl3d+NsousgIOFXDgoMjLN/AsKlif8dPI/JHoRVnbdFE/20/m3L/8B8HE6QQ==" \ No newline at end of file diff --git a/website/static/api/assets/search.js b/website/static/api/assets/search.js new file mode 100644 index 00000000..b8fe2af6 --- /dev/null +++ b/website/static/api/assets/search.js @@ -0,0 +1 @@ +window.searchData = "eJy1vV2T48aR7/1dpm/naLveANJ3smSvFUeSZzWSHc9RODYwJLobKxKgAbBnWo797k9UFUFWJf4FJEj6yvJ0VWYSSNRL/rKy/vWubT537/7w67/e/VbV23d/WL1/Vxf78t0f3n1dF7u3vtp0f/30P+Wm//ntUL57/+7Y7t794V1ZH/fdf4AWX730+9279+82u6Lryu7dH969+9/3g2yRnYV/szt2fdkyBT5szs0Dwe/fHYq2rPuErVDvn5u23BRdz1X8dGl/o+af27Lefl/V3If40NsOO9/hGt3hm6ybvuirpoYvMfwj9/193ZbFvKCHwjdLmR+ZBfX8ULS/MfTsfbPr9XxoqnrsFGNFh1O7hZpWgeMXXfdjsS//b/lG9IV/Yn9Hze64r7+tXqtt2XZzAh82rvn20hz/jshIqPfbonv51BTt9ueq31GXGuvdDs37U/Nr9X4oRh/QWNuhmPho5nX81HxmP9C2+XyHp/mxb9o33pPsbNNbn+LPTbPrq8Ossv7c7lpNf2/a37qXsqTf1ljX56Dlzdp4z/Ks8qrnuSIfIRhbL3/gf891X9XH5jhyvVjUwyZsmLD7Yhb+hqtu05b9jNEP20uz6/T8Uv9WN5/rGTXHc6sFWlbjAen74q059t+8FPUz/WWwDXvG227LLVvgQ3Fqjn8MtnZ6pPWNFphwHnQ35563W1N25a7c9IvsCPvcbMF33Z93TdFX9fPiB1J1T6eud3wi33V/q7rq0668wpxX3/OO1thharEhtu8dbfjQdJVdAy2243DqeEdbfir3zesSG9pzh5t1f1z8pdzzO/lY/b7cE7rq95s9AYzJyR0kaMEdj/+4K2q6NUiJe/h0ajzzi+b2cH/60pd1VzV0LkvqLYMON+r+bl+kJzSqtzo1vlHn9+VzWSfdhyrdDa1v1PqheC7/XO3G4YGk5kPxXD4NPW7W3hb7si9buxRrmx3fhlO/zbnfjZb817Ha/LbsQfzTdrnXk/i5/EKX7UnFvW97q0awbE+rnFy0s3X+vfz0YcGX9bn8dLjLt5XaGaU1z26QpnUnx2W3fql2Vf82P0LHbblj9V+q7XK5Dy++F+u3kt+AZ8SX5vNyKzrf6zYrwmffF39u2n2Bp8Pwj+ydybFvfK95cQ/FsW+ehsapHxWZiPepx65v9gx9m6Hhrbq+ObZtWW9o0Cytc3PpcKvuH4/7T2AQTmmuh+a36v1Qtpuy7tHwlNJ9CLvcqv/jpirrvnqqNmz9Xdjlev0f37q+XPLOO9fhLu/c6/6+qZ+/LUbRkbTuXVM/b4uJOAlfN9vfvOY7+JvX+/GlaftFP7qzPe70q3+u9nzFvW+8UGc8DidG4EW7kAasEAMRD5+ayaXgyYhE5Ae+iCAyN/fcp2Unnncsf/Y5T7A2G2yZVPB0anGN9O9GvCaWPcVppiV/PBR9VUy/1u7c5ioNfVvVz9MKhibXyMcR11jBXLwVaIi+nvInu+/Hn9Dlb+y4txu4wRsloh4254ZJswPL8K52zH+Bot0U9WVq+ZGnZvIlzOn5Ee3SRmrq6f0ZSwvj11g1N/2anxs86lFFfTM3+EFNgQdXxa55/ti/jTecl79wvfeHZjseL4iYh/2pUcLiwJ6UjnJXdpQLITVDuys1/b2qt+OdEtXzeWi1RMvl+f+p3jTbqn4GA0j4J/YeqH4evciRnIfi1AqbHJmUou0NXZaNtWxOrW7QctzTwRuq8c2u1oP2cEDP9A5uXs+3ZV9U9PMY69kOza7VA0NlYz0z4bF5Pf9ZNvuyb+muZKzp+dLwWl3fF5/K+Ue3O7W6VovNsuk4X6JLtOl63/JqbWXRHdvyb8XuWNLhDGj0rV+H1tdqBUG+sbLJ0B5HR//C0OEaXavjp9HQPFbRTgzM8xo+vhQMT+hOra7WUv3OUOIbXasD57mM1czluSQ0BbNZ2zbtN8127M/nP7Bnsg/f/dj039WV3V9Uv4/oHZH4UByquumrqH3iV1yMTOSD2Cn7611bFtu3vx7K0RRENG9d+8K3b3z7WzR/s2u6cvvHt1+68SgOVW9ch09vx25qPJ/R/V3dl21d7Fy7GbXVqW15anutxtdiV22/bfZFVfufPqvX9di6Htuhx03az5iLp/oQNL9O7w9V11X1M56kidK9bzs3U/M0cn/pSentv/Rj2b6WLcefOtfyNm/6aNPX6uePxWv5Xf2hbZ7b8SZhrNf16YrXsqoPlz7XWfBL3R0Ph6bty+2fXsu6tzkoMwYcL11K26UuJqJMC/T/UPYvzfbPTWujFx+bY7tBEYoJa/ZOwFPTbou+6JyA6dXOjG0XIsTxh9dz6yt8IpiNhqwDi7DH4QH6Z37OfnMczUZI1sPm1DJhPTUvlWn2W9+M5m6ob3tue4vGD8dPu2qzRO/B9bin9r+XnxZo/uxa36LVj1Usld3QdLE+4Jk2mpHSav+2gH2+NCCYOhZmyee56cxPcNYlvufyM0vb67nhMl2XZ/Xnqtxtv35+bsvn1NkN1IT95PqevvekuIfCN8Y/BRqKdb7SJzeh8jX98Pgav2l2NqWOrXVzbn+75uMonj2l9zgR1F6olQ7SM2rTIzVf77cFDYeklW6LdESEr/FPo8S0tMaptDS+xr80R/4X8+Ib36rzu/qvR74XVXVzvIcX/d9j2zddRZeRacW/XTrcqvuH4gtb7d61vVnjlu+7++09fPeHclsVdHs9oXRofrPeaoHS6k4ajyOeM6n0OIF1Fuht6lEobkLtqfVdtP5/ZcEfJpzmN9/jVu0/NqOzcWnFdTNxRo6v878WLCL+eZc1xH8di7YXfKVD87voVcv0qjvo/VhumgVTXTc0v1nvb+XnehxKmNB86XCz7n5bvvIVn1rfRSvd+M2oTe/6Fug9Ugg3ofSYJnF8jT+3x3qzZMnW2w73Wbc53YuWUk75ndZTTvvCScnpv9vM5C1YND15A+40Rzn9S4Ztp/0+Y7fTvXBAc+rvNqo5C/5elvTk0Iz+z77HXbQvWh847XdaHwCuklY8yVT4Ov+24Le+3uVX/q1o+WP4q298q85FDnUnX7I6twuG8M/n9rdqXuTAt/guiYX91OxQND/6Gzf69W21hyf5xsIetkHTiZ9xtm4q52Fe2/7c8GpdOPsT6JpLAU3pCt+LJXSeZMJXE/+Z/XaKvvhUdCxxNkt5aJz6GcRInFdR7srXAoTskM720nixTvr0fjzudn899MgX4z+zI7u7HcytgfIeit1uJrdmZGZq92mbLNBcN3V9vJf2hapv0kvfYNLzl/j8N0VfPjdttRllkhJZD5uo5ZT1E7HMqmyLdvPCUPcSN71O30+gHAdV1J7aXKmh3BV99VqC/OGRolPTyRRiqI+++V8OVkby/V/+zP52t+OVMZBky4vMWB6YlholeJp2c299TpOvwcBS1g5Nb9N32BUbrsKh7WKNK/gxfV++ljtf+aFq6o/92BtnWi8Y5RMFJjgK7GudrTYx97uSUchbDLOByX+PZR+b/U2Wdc3+32TZacV2i3Gntdwd7bv493f1Znfc2pG18HMsXK4kWt26apkSy1i8pGyHNvy13r35c4N9uV1uTVPv3p6G7ve260c3ZV1nVO363mzRxSNswjiY9YZ/Zr/zcRXJSMR0/cizEVD2H0eb1Fj0p4l96bTkb6p2MzpsEgvfDE2ukf+fRd33c+Y/20bX/4a/lEW/L2igJFbxcm5zjQZQ6jQWP1nadFr2DzOWX2/1h2ra6EN1rc0fmt3b82jQJNLPba7RgPL2Y/nTOfsz0i3RmhE/NLlGPqg2E0ufLDEzLftv1e+p0k2xjtfq9/mSTUDXZWT80YWyXkt/hB+W5UBNFuS7NfuiHxVkSMp0BT+GHvj3QJMT2Sh12X5oy6eK5mik9Ve2z2HocxcLPh6fFlvQDX1uteCvx37xM2hsn7s9A2fBwmfgLLjbM/jguryU3WgpkrbgEPW5yoLgKwsa/FJX/cgM+nfu9/XHarermrr7U/28qzqK6LDYh0+nTuW5U+LnjayetOFjX9TboqXbgRkjukuvm6z44SSPp31/aX2TVpDDktA4mcDC1PbzS3PsinrL/JF90Hy53lX4+fgjJm6dDdbR4wYLdlE8WZNxHWBgYo03qqSQUrerJsopcPWhKGJK4XQ0cVJj8KbKtmq26A2d/8BnGm/UzYgQmxibdq3AlGR26pyCl1Ob6zR81zUuCWpcF53qqbrmn5eWV2uziJOh6vOp2dV6LNBk6Hk7NbtOj086mVOzP7e6UovNEplVMjS6TgfTCW72AJ8oMqemO7e6TgvHyW7zMI57XeFbq+CFVJvffi5sDepitwGj1bgBm0o1+0NzrLf/2Taf+5efxtHshOiHzanjs+vYTpEWYH6C2T89lba8G9eGbdjhNt0/NK9V/fz1a9mOywik1O9dn+Lc5zYLTrUAFz+EU0HAOz6LkyXVKAY2Y0I1ERFbqPuvTz83/YhczuhvnvpTp9ts+GlceDqluZ0qO83Wd6xrW3xgwS9ufZf7/N5f6m35VNUjLpFSfgza36bZjpx/fS1b+79+BGKaYIfT5rVs7f8+Dx1vtOXnb5eZ0G/vp3nJu3/rtze898us4jDq28dDWaIFMPkrdz7587j2GpL08DRVfY1althJtvvRM4O66qHlDdo+7kZlWaCubjdRmiWtaRUsik64Lpl6AFpcn32QEjaZgIBs5GcGJFXOJAcs0IryAybUTqcITOulb85DNbocjP7GfVsfq/1hNAePJT10Q7sp+we7cJykeR6XVwOa+qHdMk3BM3op2nKbrKZD/8z260P1py/l5mgVozoMUK6trFMOvabrMYzMxmvptrHRuU/ftGWxzJLNqefm1PMe1ljOu9wSm2x5Tyu+s665twWrl9lRRf3uYslEHaCEDaxqQFztrsxOkAvtkm9BKZWULa5/cen/ZPvXxURdlUWW+USoq4zyZXz+ffa4EN6VBr2e+t7BolSdoUlT5qsNLbLhPBeBLMhJO7qh42RO5HW2XOU0Z4Pu7DeXdCdw9wbPoulLOK6zZrEPn625hwf/2PRfbyx44z8Ue9Gp63KPp/Hh2z8vn4oO26d7zkQfms9l666BvcIU29ddDXtPi9J1xLAVnGpiPM22MnwzqjuBtfbntos1hus+e2kn2MsM/86nLKcLWSYFXa5GnDB7sAi/G3sN67SO7tTkKvmp24GIjvk7gZCe4Lnb+x6q1o8kVFX4N/bzL+0X0I1LJI2lPWzDtgnrI/sSIylfY1VfrfHyzFzkpDi6UnfAZemfF3tueK0edWMo/OLNO9d17gK/0Q9IRNttmckfyq4rnsufyk1Zje9RTJjjeu59z/bS8xZr/HJvyUPxi7z7PAub8XWeqpcY4colDx3vY8vlfroFdlwup7uLDaeak90SE4aak3ey4LjfF+2b28QuMcJ3c7vYu9hhx+lPTfPbKWs8eSstNufzqffTuff9rHLTwvVmue53sSsYOduy3tq8YHeXARo7Rw24o+efvhya2jKmUcg3IfOhjHokftXY4GSu8yhfO6V4NzS+UWfzXLRV/7If5YImFUc9btNus5nrZs9/3IewwxW6L170t+p3dxfqxA0SqAmfeCduYE8K5dzFDo1OzLvwVva09tn72Wd0j5/sh2JX9pAtgBbs5+qukfi2ei3b5/FiLSX4dPvENug2/SND2yfs+Fj+8wiHixlDurDfNZaMn7YthH+aUL/eVc/1Hq8r55qz30NZj2NULOEPm6Hr9A9P/iA8jpVPdJPDs2bnO97Tlp+q55frjGlPPW+2ZtI/eG6xiMdWX0aLgimRD0+nDuwfOrWqro/J7w8q3w89rtUOnm6435t6vrQdmz11m7Lepkc8LPihCLrN/NrRL0jszK8zZFvexRJpgkdS2+hhFHJwLOWp2JTdf1z+Ov2IH6U+SyzOff7y8w/fM6Q+XHqMlQQ/LTB1VvV322WKq/R3tERtdHCKpXjyJNUi1eH3wlP9NnEAbV51fzzsSt5zdk2XPuLQS4OCHL6OC9I6asT32T7x8LDIh8knN7Y1ofQ1Pj88r3bm0PCU4sTDJDeAYBN8owUDwOGwq0ZntmdlP5z68X/lyfqEGQ5WYf9MGOB6EDftu+3/qbr/U9UvZVv5w/xXmhJRN6YxI9Z2J3NGlXI49tj/Hnn+XQyqOlRBY96mquOUzlhgxp++uHP30Y0IHDNK32/v+91oxjnks9Bjzv3u5jXyUV9Wac9l/7X/Qs8hre7r7q3eLDDxuexPX/nZ2K44ybi/uX4UvMJGf7nT2LBrDfG19Zbb4caAf9Pz6e7wOrt/7+sM56z4Hs7QNPcX/uy0pZeNY1kuu2p6nvcmXTH7BFrQlLNQSXKUoGomEzemFVX1tvwyp2RodJWC7qfydCZi9plVXRu2ZaqLvamuT5knHkJglaQR38eqxG9AAh8m3z61M6GwTvoAVDnjCUylPsfhl5++W6DZ9zm21e3qk2t2rHnmW04rDR1nnNIQKD7/ccFSeePL5J06pj7lWPKD73UmzZNv82Ixz4S/fvqfctPjgWvajMb1nPDmWVNSXkz0LlrezCr1ZsN9CtF7aXnl7+tGmTVpZa7totX2vPrwltcJzfSe15uUXhYGDNVRY/5DjtY1xdbffGjPw5c13txSR976mw93ly7X//rYmMNh9+YXNsm1FTXGdvGbrekF6Kzyp6q+JMJy1dtO5wyFZWu5WYPskjweZ/74xhpp7JI8HmY+vS0caMZLcvuE0yvesQX+nYD17VLV53eyRPv5nSxcYM8aZM/xfF1vfyrtd09eD9tAK6Sot60TQl7VrU/MHzVa+k37Xv+mz9odQ3r7uq72LmjJfUq+WzF0u/G5dKOv6XLBKdeibvRhXa49vd28/9fU5VU2/d7U5U2GoCWbuwuzhuF52mbJbpKzIAzFMvJdRybP/LIoS9F9KJPWjJtf8XtDId+WfVHtpif4hNJEvuRZ4MwDAr984W5h1sDr1mCThsGX6D/hSRN9k3s7ZyB1iW+e7F0e/oCK5+IgTLV44w013kFZ9+ddU/QhxZ1V2j1dutyo3I2su2mnjnW/nnvcpHp2mxZq5W1OpxUemq5KEWqoNOhwk+LZHVOodLRvukLh7CgVKpyMaDAVfh6dbZjTOn/MIa16YuD7cHplX9dbmzLiz28zjIL9rhgiT3GPb29S+XBFMGTq5yeMfimj3KirLD3LuL95n6ttUJnjKusGEfc3Dkax+Yal49u3GAXjz3yj0iebFhoVf599cUlZp6USIjtBQ/4X6HM5vYCPfZucTVNKTsmgPj2+6ycvlce/KTU0lJtqX+y+eSnaYpPIkpgw69R9E3S/n1ELX8RD0O0ORvhnnQ5kJs04nWGYnrcWGLJrNkVqBZQ04tzpDgbUpyK5pLY0z5Ch89PQ+Q4GHeJiyDxDZqohLzKgK22kqm/aa7+bs4A7fzndS/P54yB76fdjO3dh53sYFFeNZhoyXTZ6kQHHqFgzT//Q5zr1dH752BzbTfL79X/lzyTll946zKn0T5XapESCH06djq5TX01uVs4GT216k0801Hpuea2q1EY3VjO5/pxV0f3JPxuWpq48N75e4YfjJ1u0G6cAjFUegubXKk1vZmNtM/tYoGaUPOVwqTucNxVXj9XahCnXr3f95kKhDDMo6q6WWbM5d++G7ncw6vvm2aYAuYdjOyyxaOf7ugdkk3bubM6ipxPaco/nYss9tru3qn5e+lSO5573eCZt+dSW3QvbgFP7a9TCKSJ+DjObkYkuC7YlLn+o+7k5XcV0rbKHk6C+qc6C5h4H/rVMQ9NI9QpjZzDrVQZXz3XTll/vqqLD6eEsS72U4izlvibOXLK22Fgvz36JPru9GeTd1ex98eWn5vP1z3RffGl9/1vNol+xG0lTdrk/Lv4y56U9XFqmf4+3bCJXlKHn1OxKJVUXFFBgaKu6oHLCLWpdIdufms/fNEeL1vdVIvl+pN+VtG2bzxvbcXfueKUhri7Hd/VTw9Dt2la+7ZXqphZ8gabZ9d6kkj58tAxt0RNdpBZ+aT+VxTa98Q6a8L+6Q/Fczv+aQOqD7cH8PSd7b36YofqFj3Rkwmj5vtt9KJ5nloMjK+z6fbezj4KxHOQZYq1YbIS14C4G2NvWi26hAadOVxtAfDwu0EeUuz8uyMC1KwimwAfXeLrI38W+yeDpcKcpQ2l8i+n1il+Kzi26GCpfiq44Nb1SWX25IZWhL7gT9XqVr0xly9VE/heW4krn2oxa8T3yVKxrgdiHS5fEjxobnQpKuuWdb/9Lu1tihO/qC44d2/Qxbr4xSRqesGBZqs6UGeM3PrXnDBssQM+u28f+LbEyHkk9FXPrTj2mnu7MRmECII+1zpFijsI0Eh7rm2G/CXXhGxuK6yCFw9/478nFamdFPQzNsNlnk6aUDI3wBh6oK0//NLFJn1OMA8mxrhvEpz7hWMEkEQQq4pf9WrWNK9+CFZ3/vOQEe/W3su0SW34q0hanfz03T/2Ii5XJfe1QDGJe42amcARL3bHu8ck3oG5oe7U6W+Kt7cvtD3aGSKHjkeKh1972mvGSWRMs0LDikiMDUW6ZxqX91Wp3Rf18TEzoI51B4+sVJqn4WN00C2co2yeOyo9UTZ6NZyhqDmXrMic/vnV9uWfpPPfphj5Xq+99UcUlw8Kpyx2GhmNd/fNY/tKVbWpqIKp9h2NXtpNj96ziz6OSmiz141qa9zDie75fD12u8u9odgmPnfxQ1LaKLrQAtJucbxafWUtqmD6+Fv1c9GNuO3WTtmruAM4Sw8IXMlwJD5fil79ekQI6cUCEyL3keW7OfRK/7GIuMwMVf+Ap/bN5pvMGlDMLKKI6bn6t0qECMUdj0PZadceKo+iYPpU+r2IYcjiKgra3qHNp2Au89tznKq+Nhgd3t0I5FJtLRgOpBb7ba/V7tZ8NSM4bUdWVrf5Z/c434NLlfsr9lvQKE/x+/lZD2tIuUs/tfiotm7N3xe5KnEFPDfICyuFfWydgcxFwrWFd2X+zs9cbvrTN8TmdPAC+943t1/t+1zwfE1bVTGzf3R8W7Akv1zlNS3uIW/KiUd7KSeKZ2jQFmn3DRWGwScXbcz7fjGLbEKSx3qQ4nRxIFHdDQ+whs4oYDxYWA7r+15Xdpq2SKQWh3qjlHVTjcE+gcWIpMS24sxeYHndFX24Zn9xD1W3O7cehs+t/X/dNs/9kL7xlGnFqfVcT/tMuY4sETY/UPwct76S66Q5FVEs7rTtoehflf6m223LOpavuZWh2F6Uf2rKzt1DX5+TRb8MxYdqUg+/c1OdU0sSAcrWBqXSDwIxRqsHVytoG748DZacmd1DWlfui7qvNT/NKh6Y3KR9N6t/VXV/UE295aHDfST6Sev1kf7b++kk/tuTayX/OEMYiIDbk2sUAx5AFz+O6OXvWCMbcTey4dg6fM2XijD0wY+6EPUslf5aPld842zPMYs36I6Oun/3nTZpfBVBzrlwNcEyZXRWMbbludTBvzMwqgRpyzWph3oirVg3UtPutHuYMnlxFxGYtX03MKZ9cVcTKl0/wc8pZq4zYiOtXG8CYeNWRqpa+tET65NA9XZA8NvrqquPzpcaXKJqqJ84oIs5XNVsbm1cQe1Lh9VWvl5e6XmTIdBlpXu1ovsJFBaKXV4WeNmT01c1Vtxq3Wvg1TjvUuC4U96PhFKdKVmBJKR8XYJke27iGpNJ1UnYsXF9zzZisSpOyBRemudogXDBy5gMYW3UuHMn5Ahj1wnzDiWzEqAH/G5i9+2Asl3nvQWxx4ledEwU+Jl973GTBeSHbwn7d/7eE2U5I8IPrZAX8VqbTnqjVKQO67kNrU1H6Ch94wxZ03SHstdSE8PH+Z9kHZ4wmnAc2XJI3d9i9gQtPl6nyJXDBxafJp4B/340HJicMXHRMcpFxs4cjJ6ziHYm8wpzzdctXGdQFve9hEv9s5pRpC09kLjJx4hzmhElzpy/nTCAfPPvIdKrtv+2znziByvryp6b05A+/fTC45dj0PU3mDBFXHZy+v5FzA8esmXjsuKuh/o19vdt9kz5XPGOqF1HsdnMHjq80jjnW3XgA/Z5PdXoEXHgE/UbDwnHxL1XZFu3mZfruu3GrZWPh5OV3CeHM2+/AD0geL9r7xJjUxjZlyLnj5OaWb8hErCtlwtKL+BYas/SJLL+Kb4lBU7GztEWLL+Pjm/Ryavn2TZEcblKGnftuiukFFd+c2csBU7bwbgfkG7IrX8vdRK3zlB2u31xJc74Z9XH/qWz/+vS9FbvIEN+zedoNPW81ZTYam7LkuqsKJw27PmqbMvL2ywoXGTwd3Z0w8opbAvmGLYoCp4y8/Z7AaYMnZ/jJigETzflz/ksg5EOBD7rOKXoIhRyKiROwU79wauS6yqqh591MSZ7SnzVl+tw+z5SUp3x/GdrnbAua8j3EPcbzbuhjn6htPqXHv4rzhqg7yZh/GuFvW4iXJ+1hLw+xAZOvYnZa860WvoAlUh8WTJInk/FvC2sJIv3h3xcEtdNLs5HAh7m1WGTiosThsa6JQGhCTfiwfija31KloIa/LXhIza6BG7xI1MPQDFt9NimFzOzd9nh7E6txDScez6yixB6BaJli60AFffrdN81uImhDmiw5ZYeLmyGB0wXVqJUTv2XYNSSp8bgV/xclAWVC6EJoC37AFY6B7Fi0beSbMQltU7Ysh7aTBtE1tWucXK6mjHoue1dobhrZThsycsVDuameqk0yt3jciu+KQx0QOMElBD+EnaZ+YWR4woBDa6sA2vLGk744NuLccXbcShoSPurz1YrIhvMfF0Tzdrvms52v0vG8WOrDucdMIO9iaWryOra2aXLnQvSemk8vkmeVTqVYE4Wz96PPKsNLCqJmYsKcVZBa1hIVkwtZpGTx2X3qI9feNztrjL8+z/lMctSjjuO6OL+ZHu9mlTNLBhD9t1zUCU1Cw8Fc9hhsyB8mUjNwWuyySRj/jvS0N3/r74Rl4WWzTI9g5C2d237b7Iuq/qm0V/Ukl5np1v+esRurWT6Yj39ceqAtP/bl4UPZVs30OJiwzUro+vJwGCTcy7R98WV+0kkYtS++MGcgvjlVfb05VX1vc+wj/5i4FnDOHNt38pbA5ebMjjwJU3gz95QZ0cfdVIlx1f6B/8nC23AuMiZuX/MWJMTCtL9AbDrDj4oNf/RP7upb94SQ/ODP/AewL+AjoLIefDtsc2hX+pviqanSQSOGmpRzjvRMeiNWNHoTaZwf/PkuJzSovMW4OrT3Gk6NDViE0lgmTJFpYMNiJM0w4pS48uNxt0tP4yNbTr3q4243M3MzTJiaD0eaZydAjsKJGW+scG6KYyicxbgjrdfxW2zK9eB2ZNbtxJZnoh+NFtm1dV2m19M85dOcGOm+AhAzTFlEhkdm3Y6EEybieWEi/3Xc6j7zNTgwMTttp85KsGdvpHRuEmcptWNpOvswpdv2msmsnjRh9DanB8aF3H7q7QXgefatTQLvqbcVKpl7S9Pl9uffTlhun/lWpuj5T+XOFe3/tuinll6jVgv27/XmpbEUH79vLPnB99pOwXFg+hWLwIT+xWvBZcYkZ+gpc5ZN0gsMmlwgJi1avk5km+SDIUtN8r2mNyFsE1r75fy4RL3rMfEpLlO99Me7Tnf67fMLyYQRV64npwy7YVmZMPIOq8slBs+s89JGXrPcYxu2bNWXMPIOi79JgyfnqamlYKrxv2/Wio8/XTN5zd0IvnBIjG8Gv2ZknDFoyQAZGbN4nOQYcuWDuWbUnF7enrMDv7HO3lYwW2bUaGFAKzUuY7mMGgdjq5fmfSZUTwc1ptTGD7VPlpke/rbkjPwPzbZ6qvAxhEjeQ9XtL21TP+Jk3A1kOVZ6NVieM8WSwMTbC/UPza77vc84dShW8Vymy1YzFHy9gwm+Ix3FLp31PKeGycFjnbdg8DmDuuI1nQ4Qm2GbTgepZpVx3mK38C2CT3oO6aN2/E+9Lj9zxo4xPa/Lz7P16uFPWMhQ0hYs2lrNmBI9+FRu38J6HKmsnKD2xfSUM1Vrw60lU3N6oMG1m5y/p9UkCHCoYQr0jop1LB73L4quH/SnjHiq6u18Gklghu3AzBuZVBymr6R3FoHiMF9lJmVzUjF32L5ovmnMnijXksovsP++4FRS8pK/s5y5u/2cIam9fupKv4v06Zv8iPDoAVzqXMwO87jpHdK4pyQvzOVO/Z6lY/6URcuG/WUGTaZ2T1q1PL973rTQU372d2z9qW3xSY/w7wvyqW3zbxKFsEYiH1zzzVQNrMjM6V+ScvTw77dnJo6kTedgRMZN2u/GtbkfcWl0h+8UywRfKPhBgbXXPUCqddFXOGUEeLTngNvc440b3u8RA7kLB0L8S6579Miaax4/z5jJIXDCIjwALjFj5AmnETJpyOnvS87J1bUPp2DWNZL6cOkxkZ8fGZs85dD1zf7jf33P1Ouad/9Mb845SvHBg7G2G39baqMzVjS530moityiaXZ9dfgmfYNs3GLB/OH7fe0C08k0TyD94dTTh7QPp56JXxibj3/jL98hzb98N/lb4sMRu6Y7XdY1IerBNdsOzbDFv3yXUrKtusOueJu5E2zQdWrNuQgsrbIr6210m/msWtvD6zzdHH831T83H1yv5Sb0jde3xJTAPf5WdcdiN3vKDjRbwHY2NqA/Poz2Xb0tYSZJStuDl+QOGXbhX6uTJPzj0W9MDum2EplDiDCAlbTMd3waOt5syH70tJbZM35GdzGrbT5f8XDa5vNNTyZ02L9P3Bc5/I0/tvnQ9rfna9PSkZNI9inUfbm2YCaAcjZ6+jdNl4Act1pAseJ6t/D1JeQ/XPp2Q9/pXxn8DO7vnQtXTPe45jlcqeWBUVZ35uctXLZzjFq0fmebR19Zch1//iP/RXwqNr89t82x3n6TqjYRS3249JguPHGx9GofCLQyX/ekwtSClqhalMMzq9S3/Ha48Jih3/fYBj2u/L2TMIEoxUDhpl+eggxUMwUNS5Uuhg/EgKsBxLwxdd3YOkd2yTU5oYXWnPrYhcP8ZDat3lYjnqn7T7XbLpyC/zzl46pWiwwJa4rdz6ggY3uRNS5n5o5mjBJslllz6m6zre5i1GZXFu0yQ1yX+ykfipFMVz1BNgxVMhllT2ZN4ZFDOj1N08ObRhG7NvaDgt09cC2yK+NLrxufiT0zxFybxyYsWpnPmeCdc4l675t3UP2X6vllZ1njQu98LvuXS9d7uCePL4/NmGLMt7rnVR/uc9nf87N9Pl8vcCqEbguFLbHFdz6VQK/qp+ZuBtlPZ7kl9tO5qwk/lcWWP6LFhrSu7+3mnEKlP5df0iG2sSGnWKyNrt5uQlxvfYEVx3PH+7yaiyEuRH61Nb3t/W8zabHXAMPu5T3EvCVDDbHqDqMNCJUtsOfV9Y4Cgzea9NK8lu3Ptkgj1wzXw5V1vFH1rix8XPnH4rV6XvQoXFc7/tfnrjca47OaLismriW+32XNdBczlu5Fb0nJmjXJT7dukv7j23SRLbpHdz3dNP3pjVFri2mK81b2V+z7OH+95vNFQTSH7NKRzrANP6Q2idqhWAZlH5k888vmQ9ik2f1j2EjBsiA2/SXs38wJY090uWcce07Nosjmskj2vBNO2bUsM+ZKE6eC7bMWXheuXGYg72OesnJ5CiHfVPm4zoWRZ2u/KfryuWltvCyuNGAfVfcf9M8zfC6WfQ5hf1+8NcfeW0SvE/F6pppep/Ovn/6n3PQfmq5yU3q9tdm3vxxs8Ovrti3eUgbM9bvFmr9VXfWp2lX92w/FYdqAqOlCnX3h3WCkYfjDggSAL1VHj49CaQ+2ZXOYxtWBaQl92/KpOO56nspT49u1dsdPfdMXO+ZPPTe/XfMStTfopD4SZrf+pai3u7L9c03UwzaLPDGU8Evdls92fTqtKGy2SNf/a+py6vMa/f0G6REgQ+Jtg0n5iiX6tWgrt/VcKj5ysb9U2wUiH16qiaxu0Om//9tNqgnlH1+azwuUd775YuX/eP/OJxL94V/vXsvW3uX27g/v5Ffqq/W79+9OGSx/+HXguZtmv/frvG2zObr//Mep2d/KTd+0trFv/R+P797/+vg+k18Zaf7xj/e/Dp3dH9w/DDIu/+I6infvfxWooxh1FFFH+e79rxJ1lKOOMuqo3r3/VaGOatRRRR31u/e/6vcm/0qLPOqoRx111NG8e/+rQR3NqKOJOmbv3v+aIVOzUccs6pi/e/9rjjTmo4551HH17v2vK9RxNeq4ijqu373/dY1MXY86rmMHsP4goO+IsfMI4j3OfbD/AAeKPUhYvxDQh8TYiUTsRcL6hoB+JMaOJGJPEtY/BPQlMXYmEXuTsD4izHstvxKGdB47lIg9Slg/EdCnxNipROxVwvqKyN8b/dWjkXHnsWOJ2LOE9RcBfUuMnUvE3iWsz4g17Dx2MBF7mLQ+Ix+R2XLsYTL2MGl9RkIPk2MPk2SMcoMUHqXAMBV7mLQ+I6GHybGHydjDpPUZqWHnsYfJ2MOk9RlpYOexh8nYw6T1GQk9TI49TMYeJq3PyBx2HnuYjD1MWp+RK9h57GEy9jBpfUbCEUyOPUzGHqaszyg4hqmxh6nYw5T1GQU9TI09TMUepqzPKOhhauxhisyEbirEcyGYDGMPU9ZnFPQwNfYwFXuYsj6joIepsYep2MOU9RkFPUyNPUzFHqaszyjoYWrsYSr2MGV9RkEPU2MPU7GHKeszCnqYGnuYij1MW5/Rj3D1MfYwHXuYtj6joYfpsYfp2MO09RkNPUyPPUzHHqZVcq7SYw/TZL3lFlzQPTVYcsUepq3PaLxcG3uYjj1MW5/RcMmmxx6mYw/T1mc0dE899jAde5i2PqOhe+qxh+nYw7T1GQ2nWD32MB17mHEeBt3TjD3MxB5mrM8YOACasYeZ2MOM9RkD3dOMPczEHmaszxjonmbsYSb2MGN9xkAPM2MPM2RV75b1cAA0YGEfe5ixPmPgAGjGHmZiDzPWZwz0MDP2MBN7mLE+Y6CHmbGHmdjDjPUZs3qv118ZpeLOYw8zsYdl1mcM9LBs7GFZ7GGZ9ZkMelg29rAs9rDM+kwGPSwbe1gWe1hmfSaDHpaNPSyLPSyzPpNBD8vGHpbFHpZZn8mgh2VjD8vI3tFtHqGHZWD7GHtYlieXzNnYw7LYwzLrMxnet449LIs9LLM+k0H3zMYelsUellufyeD8nI89LI89LHceBt0zH3tYHntYbn0mh+6Zjz0sjz0stz6TQ/fMxx6Wxx6WW5/JoXvmYw/LYw/Lrc/kCkYKxh6Wxx6WW5/JoXvmYw/LSYTChSige+YgSBF7WG59Jocelo89LI89LLc+k0MPy8celscetrI+k0MPW409bBV72Mr6TA53sauxh61iD1tZn1nBFeBq7GGr2MNWKrkyWI09bBV72Mr6zAq652rsYavYw1bWZ1YSah572Cr2sJX1mRUcPVdjD1vFHrayPrOC7rkae9iKxMFcIAy65wqEwmIPW1mfWUH3XI09bBV72Nr6zAq653rsYevYw9bWZ1bQPddjD1vHHrZ2HoaDeGMPW8cetrY+s4buuR572Dr2sLX1mbV4r/OvVlk83azHHraOPWxtksG09djD1rGHra3PrOHouR572Dr2sLX1mTV0z/XYw9axh62tz6yhe67HHrYm0VYXboXuuQYBVxpxtU6zzmA07RHFXEnQ9dH6zRq6qP8b7U/iro/WddY4FPgIIq+PJPT66HwNOqr/G+1Poq+PLvz6mIg5gwDsI4nAPjqXexT4F4Ag7COJwj66MOwjjj0/gkDsI4nEPrpQ7COOPz+CYOwjicY+unDsI/Q//0cqgERkH11I9hH6oP8jFUC88BT4x7FoFPofxf5d8P8R+yEM/xM/9ADgEQ6XAiEAygA8BHjEnogwAOUAHgQk6AdCAZQFeBiQIiDAEykP8EAgQUEQEqBMwEOBBAlBWIByAQ8GBPZEhAYoG/BwQGBPRHiA8AHhQv4iQUUAIhCEEQjpMRT2RIAJBOEEwoX+hcCeCFCBIKxAuPC/ENgTAS4QhBcIhwCExJ4IkIEgzEA4DCAwKREAGwjCDYRDAQLTEgHQgSDsQDgcIDAxEQAfCMIPhEMCAlMTARCCIAxBOCwgMDkRACMIwhGEQwNCZu+N+MqodSwAoARBWIJweEBggiIAThCEJwjloSj2RIAUBGEKwmECIdf4JyA0SjzRoQKBaYoAaEEQtiAcLhCYqAiAFwThC8IhA4GpigCIQRDGIBw2EAruqwXADIJwBuHQgcB0RQDUIAhrEA4fCExYBMANgvAG4RCCwJRFAOQgCHMQDiMITFoEwA6CcAfhUILAtEUA9CAIexAePmDiIgB+EIQ/CO0xPfZEgCAEYRBC+60J9kSAIQThEMKhBYHpiwAoQhAWIRxeEBiiCIAjBOERwiEGobEnAiQhCJMQDjMIjT0RYAlBuIRwqEFgoCIAmhCETQiHGwSGKgLgCUH4hHDIQWjsiQBRCMIohMMOAsMVATCFIJxCOPQgMGARAFUIwiqE8Ukj2BMBrhCEVwiHIAQGLQIgC0GYhXAYQmDYIgC2EIRbCIciBAYuAqALQdiFcDhCYOgiAL4QhF8IhyQEBi8CIAxBGIZwWEJg+CIAxhCEYwiHJoTBnghQhiAsQzg8gQP7AtAMQXCGyLwjYk8GREMQpCEcpRAY5AhANQTBGiLzGUzYkwHZEARtCEcrBAY6AtANQfCGcMRCZHh2B4RDEMQhHLUQGOwIQDkEwRzCkQuB4Y4ApEMQ1CEcvRBZhiJuAtAOQXCHcARDYE4jAPEQBHkIRzEEZjUCUA9BsIdwJENkOCcMkA9B0IdwNENgZiMA/RAEfwhHNATmNgIQEEEQiMh9Ph0MjgtAQQTBIMKRDYH5jQAkRBAUIhzdEDnORAQ0RBAcIhzhEDlMlRCAiAiCRISjHAKzHAGoiCBYRDjSITDPEYCMCIJGhKMdAjMdAeiIIHhEOOIhcjwmAkIiCCIRjnqIFfZEQEkEwSTCkQ+xEnDPBUiJIKhErPKJIQ3QEkFwiVj57E48qAJiIggyEY6CCMx6BKAmgmAT4UiIwLxHAHIiCDoRjoZgRwbsRBB4IhwPERgZCcBPBAEowjERgbGRAAxFEIgiHBcRGB0JwFEEASnCkxSMjwRgKYLAFLH2foi/BMBTBAEqwjESscZfAmAqgkAV4TiJWOMxGXAVQcCKWPtMY+zIgK0IAlekhysQhEkAVySBK9LBEoGpkgR0RRK6Ih0twamCEtAVSeiKdLREYDIlAV6RBK9Ij1cwnZIAr0iCV6THK2ucQwzwiiR4RXq8ggmVBHhFErwiPV5Z41xigFckwSvS4xXMqCTAK5LgFeloicSMSgK8IglekcJnvScy14EjErwiHS2RmFFJgFckwSvS0RKJGZUEeEUSvCKF36xgTwR4RRK8Ih0tkZhRSYBXJMEr0uMVHMiTAK9IglekoyUSQy4J8IokeEUKn4mFXRngFUnwihQTa0QJ8IokeEUK74n4WwB4RdLjFx6v4JW6RCcw6BEMfwbjcQ1PcKBTGKNjGM4TMWaT8CQG8UR/FgNjNolOY9DjGP48BsZsEp3IoEcy/JkMjNkkOpVBj2X4cxkYs0l0MoMezfBnMzBmk+h0Bj2e4c9nYMwm0QkNekTDn9HAmE2iUxoEr0hHSyTGbBLgFUnwilT+NBAe1gFekQSvSOVPBGFPBHhFErwiHS2RiQNJAK9IglekoyUycSgJ4BVJ8Ip0tESmDiYBTyR4RTpaIhOHkwBekQSvSEdLZOKAEsArkuAV6WiJTBxSAnhFErwiHS2RiYNKAK9IglekoyUycVgJ4BVJ8Ip0tEQmDiwBvCIJXpGOlkiM2STAK5LgFan9+TTsiQCvSIJXpKMlEmM2CfCKJHhFOloi8QEmCfCKJHhFOloiMWaTAK9IglekoyUSYzYJ8IokeEU6WiIxZpMAr0iCV6SjJRJjNgnwiiR4RTpaIjFmkwCvSIJXpMcrOIolAV6RBK9Ij1dwEEoCvCIJXpEer+AglAR4RRK8Io33RPwxAbwiCV6RjpZITAolwCuS4BXpaInEpFACvCIJXpGOlkhMCiXAK5LgFeloicSkUAK8IglekY6WSEwKJcArkuAV6WiJxKRQArwiCV6RjpZITAolwCuS4BXpaAlOjJSArkhCV6SnK5g0SoBXJMErMvPHdvHHCPCKJHhFZt4RsScDvCIJXpGOluDcTAnoiiR0RfqTI5hUSkBXJKEr0sESiUmlBHRFEroiHSyRmFRKQFckoSvSwRKJSaUEdEUSuiIdLJGYVEpAVyShK9LBEolJpQR0RRK6Ih0skZhUSkBXJKEr0tMVnOEqAV2RhK7I3J8hTxzlBo5I6Ip0sESaFYppS0BXJKErMveeCBORJKArktAV6WCJxKhSAroiCV2Rnq7A068SwBVJ4Ip0rERi1CkBXJEErkjHSiRGnRLAFUnginSsROLzaxLAFUnginSsRGLUKQFckQSuSMdKJEadEsAVSeCKdKxE4uNoEsAVSeCKXPmCBtiTAVyRBK5Ix0okRp0SwBVJ4IpceUfEgzqAK5LAFelYicSoUwK4IglckY6VSIw6JYArksAV6WiJxMfUJMArkuAV6WiJzLEnArwiCV6RjpZIfFxNArwiCV6RjpZIfGRNArwiCV6RjpZIjDolwCuS4BXpaInEqFMCvCIJXpFrX14DeyLAK5LgFeloicSoUwK8IglekR6v4OUFoCuS0BXlaAkuBKMAXVGErigHSyRGrQrQFUXoinK0ROLTcArgFUXwinK0RGJSqgBeUQSvKEdLJCalCuAVRfCKcrREYlKqAF5RBK8oR0skRp0K4BVF8IpytERi1KkAXlEEr6hHX+oFl/EAeEURvKI8XsGoUwG8ogheUR6vYNSpAF5RBK8oj1cw6lQAryiCV5THKxh1KoBXFMEryuMVjDoVwCuK4BXl8QpGlQrgFUXwinK0RGLUqABeUQSvKI9XMGpUAK8ogleUxysYNSqAVxTBK8rREhi6UACuKAJXlIcra1irTQG4oghcUb64FSaVCsAVReCK8nBlvX6vsq9WeUYEAD8kcEU5VqIwqVQArigCV5RjJQqTSgXgiiJwRTlWoh5hBEoBuKIIXFGOlahH9V6br0S+JgKAHxK4ohwrUY8aCwB+SOCK8mdXcEKeAnBFEbiiHCtRjzAGpgBcUQSuKMdK1CMMfigAVxStgXUqgpWj4iAKlcGidbB8IaxHWF1EoVJYtBaWL4b1iFcHqBzWqB6W80TxiC1AJbGIJ/qiWEJgAcATaV0sx0rwKX+FKmPR0lgOleACLQoVx6LVsXx5rMSXgApk0QpZvkRW4ktARbJolSxfJguTUoUKZRG0ohwpUZiUKoBWFEErSvuCbInSZsAPCVpRjpQou/EHzwCgFUXQitLeD7P3WnylJHmNAK0oglaU9n6I10cArSiCVpRHK4lZAaAVRdCK8mgFR18UQCuKoBXlSInCrFYBtKIIWlGOlCjMahVAK4qgFaXXU28BeCJBK8qREoVhrwJoRRG0ooxIx8AUQCuKoBXlSAkurKAAWVGErCgHShSmzQqQFUXIinKgREmJLQCOSMiKcqBESZi+ogBZUYSsKAdKlNQoeUQBsqIIWVEOlChMmxUgK4qQFeVAiZJ4ZgVkRRGyohwoURIWXlWArChCVlTmHRF/S4CsKEJWlAMlSq7hawRkRRGyohwpUYkSmQCtKIJWVOZrVWJPBGhFEbSiHClRiVKZAK0oglaUIyUK54IpgFYUQSsqmxoSAVtRhK0oh0pUouYmYCuKsBXlUIlSeJEI2IoibEV5tpKYFgBbUYStKIdKVKJ4J2ArirAVdWIr+CECtqIIW1G5nFjhALaiCFtRuZqY3QFbUYStqNx7YqIGKfBEwlZU7j0Rf86ArSjCVpRDJamZDbAVRdiKyr0n4rkVsBVF2IpyqCQxMQG0oghaUfmUIwK2oghbUf7gCmQzCqAVRdCKcqREYeKvAFpRBK0oR0qUhoRNAbSiCFpRjpQoLeGsANCKImhFrXwFX4UFAD8kaEU5UqJwkVUF0IoiaEU5UqJwoVUF0IoiaEU5UqIw8VcArSiCVpQjJQoTewXQiiJoRTlSojCxVwCtKIJWlCMlChN7BdCKImhFOVKiMHFXAK0oglaUIyXKYE8EaEURtKIcKVGYuCuAVhRBK8qREoWJuwJoRRG0ota+njSeGQFaUQStKEdKFCbuCqAVRdCKcqREYeKuAFpRBK0oR0oUBuYKoBVF0IpyqEQZyFYUYCuKsBXtWInCZ3s1gCuawBXtWInCwFwDuKIJXNGPExtnDeCKJnBFO1aiMDHXAK5oAle0YyUKE3MN4IomcEU7VpKYWjWAK5rAFf3oq5vjstcArmgCV7RjJQojdw3giiZwRTtWojBy1wCuaAJXtGMlCiN3DeCKJnBFO1aiMhgV1wCuaAJXtPCeCEdlDeCKJnBFO1aiMHLXAK5oAle0YyUKI3cN4IomcEU7VqJygWZnDeCKJnBFO1aicrg+0ACuaAJXtJg4VaoBXNEErmjha+3DBYYGcEUTuKIdLVGY2WuAVzTBK9rREoWZvQZ4RRO8oh0tUTncu2uAVzTBK9rREoWZvQZ4RRO8oj1ewcxeA7yiCV7RHq9gZq8BXtEEr2iPVxJDGsArmuAV7fEKjmprgFc0wSva4xUM3TXAK5rgFe1oicLQXQO8ogle0R6vpH4C8ESCV7THK5jaa4BXNMEr2uMVTO01wCua4BXt8Qqm9hrgFU3wivZ4BVN7DfCKJnhFe7yCqb0GeEUTvKI9XsHUXgO8ogle0f7eEUztNeArmvAV7e8ewdReA8CiCWDRHrCs8bAOAIsmgEV7wIKpvQaARRPAok/3kGBPBIBF06tIPGDB1F6j20jodSR6AjlrdCMJvZLEAxaM/TW6lYReS+J4CT4TqdHFJKObSXR6763h5STEEbVJ7701uqCE3lCivSPijxFdUkJvKfF8BWceaHRRCb2pxPMVnHmg0WUl9LaSE1/Bq310YQnhK9ofXUn4EeArmvAV7XCJWkNgrAFf0YSvaOPP2uPhAAAWTQCLdrxE49wHDQCLJoBFO16i8SltDQCLJoBFO16i8SltDQCLJoBFO16i8SltDQCLJoBFO16i8SltDQCLJoBFe8CCAxgaABZNAIt2vETjU9oaABZNAIvO/PVMeGYDgEUTwKIdL9H4kLUGgEUTwKIz74l4ZgOARRPAoh0v0QKvcABg0QSwaMdLND4jrQFg0QSwaMdLNCb/GgAWTQCLzrI0bNQAsGgCWLQHLBhzaQBYNAEs2vESjXMPNAAsmgAW7XhJAjJpAFg0ASzaAxYcVtYAsGgCWHQ+NSYCwKIJYNGOl2hckF8DwKIJYNG590R8/RYALJoAFp17T8SbNgBYNAEsOveeiOdGAFg0ASza8RKNkxc0ACyaABbteInGyQsaABZNAIt2wETj3AMNCIsmhEU7YKIx+teAsGhCWLQjJhofNNcAsWiCWLRHLIkVCkAsmiAW7YiJxrkDGiAWTRCLPpUGg4s0QFg0ISzaARONcw80ICyaEBbtCQuO6WpAWDQhLHqVzgfTALBoAli04yVa4m8RABZNAIv2gCWxyAOARRPAolfeD/HHDACLJoBFr70fYjcCgEUTwKIdL9Eyca8e8EMCWPTa+yEeUgFg0QSwaMdLtMJzMwAsmgAW7XiJVnhWAIBFE8Ci11NhbQBYNAEs2vESrWCOrgaARRPAoh0v0YmZEQAWTQCLdrxE4+wJDQCLJoBFr9cTwwkALJoAFuMPr8DhxAC+YghfMY8iPZwYwFcM4SvG4ZLE9X0ArxiCV4yjJYnRwAC8YgheMR6v4OQLA/CKIXjFOFqSGA0MwCuG4BXjaEliNDAArxiCV8xjnh4NDMArhuAV87hKjwYG4BVD8IpxtCQxGhiAVwzBK8bRksRoYABeMQSvGI9X8GhgAF4xBK8YR0sSo4EBeMUQvGKESo8GBuAVQ/CKcbQE30tmAF0xhK4YMXFkwAC6YghdMWLiyIABdMUQumLExJEBA+iKIXTFeLqCE/YNoCuG0BXj6QpO2DeArhhCV4ynKzjf3gC6YghdMZ6u4Hx7A+iKIXTFSO+I+CJWQFcMoSvmdHgFv0ZAVwyhK0b6qTl7r7OvtBJEAPBEQleMnEjVNoCuGEJXjL94BaZCGQBXDIErRvqZGV8pC+CKIXDFSD8zw92SAXDFELhips6uGABXDIErRvkREd9+DOCKIXDFOFaC5wSAVgxBK8aREo2zyQxAK4agFeNIicb1YwxAK4agFeNIidZ4QARoxRC0YjxawbzaALRiCFoxHq1gXm0AWjEErRhHSrTGcwJAK4agFeNvXcHA2wC0YghaMR6tYOBtAFoxBK0Yf807rqFjAFoxBK0Yf9V74jUCtGIIWjEerSReI0ArhqAV48+uJF4jYCuGsBXjr31PvEbAVgxhK+Z09Tse0wFbMYStGD2R+GAAWzGErRg9kfhgAFsxhK0Yfw08zms0gK0YwlaMZyv4SKQBbMXQ2+D9dfA4MdKgC+HpjfCerSQWSOhSeHorvJETMyu6GJ7eDO/LgiUWSOhyeHo7vGcrOLfToAviRzfE+0Ui3i/BS+KJJ3q2gpNDDboont4U79kKTg416LJ4elu8mVokogvj6Y3xZmqRiC6NJ2zFZFOLRMBWDGErJptaJAK2YghbMZ6t4JJUBrAVQ9iK8WwFJ8gawFYMYSvGsxWcIGsAWzGErRh/eAWnHRjAVgxhK8ahEo0zbA1gK4awFZN5T8SjMmArhrAV4w+vJDadgK0YwlaMQyUap+gawFYMYSvGoRKNU3QNYCuGsBXjUInG1/cYwFYMYSvGsxWcomsAWzGErZipwysGsBVD2IrxbAXn+BrAVgxhK8ZfOY+jHwCtGIJWjK8LhqmAAWjFELRifF2wxH4JoBVD0IrxaAUnGRuAVgxBKyZfp5MKDUArhqAV49EKzlI2AK0YglaMIyWpTSdAK4agFeMLgyUeIkArhqAV49EK3nQCtGIIWjEereA0aQPQiiFoxThSonGatAFoxRC0Yhwq0ThN2gC2YghbMZ6t4DRpA9iKIWzFrLwj4vEIsBVD2IrxbCXD+1bAVgxhK8azFZwmbQBbMYStGH/pCl4cALRiCFox64kTAwagFUPQillPHLU3AK0YglbMeuKEswFoxRC0Yhwp0ThT3AC0YghaMf7sCs5aMACtGIJWjEcruLqbAWjFELRifFmwxGgA0IohaMV4tILLwxmAVgxBK5lDJRqXh8sAW8kIW8k8W8GfQgbYSkbYSuavXcG56hmAKxmBK5mHK7iKcQbgSkbgSuZYicbTSgbgSkbgSubhCs5VzwBcyQhcyXxhMOwHGYArGYErmWMlcGrPAFrJCFrJ/MkVfCAxA2glI2gl8ydX8IHEDKCVjKCVzKMVnK2fAbSSEbSS+Uvt8Q3QGUArGUErmb/UHt+/nAG0khG0kp3KguGXCNBKRtBKJrwfwkkhA2wlI2wlm2IrGWArGWEr2RRbyQBbyQhbyabYSgbYSkbYSubLguE6gxlgKxlhK5lYT4wGgK1khK1k8nFiNABsJSNsJfNsBe/8M8BWMsJWslNhMDi5Z4CtZIStZCe2AvcKGWArGWEr2enkCgwdZICtZIStZP7kCg4dZICtZIStZI6VaHxyJQNwJSNwJTtdao/HAwBXMgJXstOl9ng8AHAlI3Alc6xEY1SaAbiSEbiSebiywnMzgCsZgSuZmhoTAV7JCF7J1NSYCPBKRvBK5vFK4hkAvJIRvJJ5vIJP72QAr2QEr2SOlugVHg8AXskIXsk8XkkMqgCvZASvZKfSYHhQBXglI3gl83glMagCvJIRvJL5W1fwPVAZwCsZwSuZxysrPCYCvJIRvJJ5vLLCKxSAVzKCVzKPVxKDKsArGcErmccriUEV4JWM4JVMT42JAK9kBK9kempMBHglI3gl035MxGskgFcyglcyR0tS3wLAKxnBK5m/dSXhSACvZASvZHo95UjAEwleyTxeSTgSwCsZwSuZ8Z6IF1kAr2QEr2RTeCUDeCUjeCXztcFwSDkDeCUjeCXzeAUnimcAr2QEr2T+6Ao+jJcBvJIRvJKZiQMDGcArGcErmccruAZvBvBKRvBK5miJxqf5MoBXMoJXMn90BZ/mywBeyQheyU61wWD0IAN4JSN4JfNHV/BxwAzglYzglczjFXyaLwN4JSN4JfN4BZ+FywBeyQheyTxewfeFZgCvZASvZNlEDk4G8EpG8Erm8QoOyGYAr2QEr2T+6AqOY2UAr2QEr2Sne1dgrcEM4JWM4JXM0RJc0ikDdCUjdCXzJ1cSHyOgKxmhK5k/uYLTYzNAVzJCVzJfGgzX2csAXckIXck8XUl8S4CuZISuZA6WJJ4hgCsZgSuZrwyGz6VmgK5khK5kvjIYPpeaAbqSEbqS+YMr+FRoBuhKRuhK5ulK4ksAdCUjdCWbKg2WAbqSEbqSTZQGywBcyQhcyTxcwXf/ZgCuZASuZI6VGHyqNANwJSNwJXOwxOBTpRmgKxmhK5m/dSXxDAFdyQhdyRwsMfhYagboSkboSraaGhABXckIXclWE5gvA3QlI3Qlc7DE4IOxGaArGaErmacrqZ8AHJHQlWw9cb45A3QlI3Qlc7Qk4cmArmSErmRr74h4agd0JSN0JVt7R8RTO6ArGaErmYMlBp/MzQBdyQhdyU4HVyAgygBdyQhdydYTtRIzQFcyQlcyB0sMPhucAbqSEbqSrb0j4iEV0JWM0JXM0xV8oDIDdCUjdCV3sMTgw8U5oCs5oSu5gyUGX8CcA7qSE7qS+5Mr+HBxDuhKTuhK7mCJwYeLc0BXckJXcgdLDD7amwO6khO6kjtYYnBZ8RzQlZzQldzBEoMvYM4BXckJXckdLjH4AuYc8JWc8JXc4RKDy4rngK/khK/k/ugKPpmbA76SE76SO1xi8MHaHPCVnPCV3OGSxDH3HPCVnPCVXHhPhEHpHPCVnPCV3OESg0/m5oCv5ISv5A6XGAk33jngKznhK7mY2K3kgK/khK/kIn1iIAd4JSd4JXe0xOCjwTnAKznBK7mjJclHAByR4JVcTNR2zwFeyQleyR0tMfgW7BzglZzglVxO1HbPAV7JCV7JZbq2ew7oSk7oSu7pCt5v5YCu5ISu5NL7IR7QAF3JCV3J5URt9xzQlZzQldzBEoNLs+eAruSEruTSOyIeEQFdyQldyaV3RDwiArqSE7qSO1hicGn2HNCVnNCVXHlHxHMzoCs5oSu5mtg254Cu5ISu5A6WGFzbPQd0JSd0JXewxODa7jmgKzmhK7mvC4ZPheaAruSEruQOlhhcHD4HdCUndCX3dAWHDnJAV3JCV3IHSwy+yzwHdCUndCV3sMTg4805oCs5oSu5gyUGH4XLAV3JCV3JHSwxuLZ7DuhKTuhK7mCJwQfJckBXckJXck9XcN3QHNCVnNCVXHtPxF8joCs5oSu5gyUGHyTLAV3JCV3JHSwx+CRYDuhKTuhK7mCJwSfBckBXckJXcgdLDL5JPAd0JSd0JXewxOCbxHNAV3JCV3IHSww+BZUDupITupKbiZh2DuhKTuhK7mCJwUeIckBXckJXcgdLDD7AkwO6khO6kvvCYLgETQ7oSk7oSu5gSWKNBuBKTuBKbrwj4o8RwJWcwJXcZBMLZQBXcgJXcuMdEX+MAK7kBK7kZmqVCOBKTuBKbiYiODmAKzmBK3k2EcHJAVzJCVzJs3QEJwdsJSdsJc+8H+LxCLCVnLCV/HTvCowd5ICt5ISt5A6VGHwCKQdsJSdsJXeoxODTNzlgKzlhK7lnK4kFDmArOWEruUMlBh/fyQFbyQlbyR0qMfj4Tg7YSk7YSu5YicGnb3IAV3ICV3LHSgw+fZMDuJITuJI7VmLw4ZkcwJWcwJXcsRKDD8/kAK7kBK7kjpUYfHgmB3AlJ3Alz70n4gEJ0JWc0JU8N1MCgCcSupL7smAQeOcAruQEruQeruBvEbCV4d/+8f5dVb+WbV9uv6u35Zd3f/j113fFpq9ey23RvXxqinZrFbx7/693/135FvbmNaf13R/+9c7erfaHf/3v/74f1Nn/9/6syP3NaiYym0//U276ahvLXYdyVwvk7ov2t647lJvqqdoUfdXUXmYg3YbXztJtAI0lfRtZKHJ5kSHy3PeSRnCFlZE4GUiTki3jtaz7XdX1ZV220fML5dnb0pwIW8nQ/Yc9XeD+w6Yq+P/IH/1/2P07S/vzc1s+u+cbKraFj86KbaU0r3i95gndVUX3WuyOsZOt8kCmYtq328WvS4Wva3V6XYLpWbtd87n4tCudbV30g7PgC7AnX/zjfGT6wW7Xlbty05fEuYJfLFZMf9jtxuaJLPzd2el3ixXzS62L3VtfbTr/jfZvh+jFPF5EPzLlbV6adlv0kRibo3UWZDMS/SPkjib18y4SlwcvZMW1q276ondjR9G91ZtotJDhaCH1Eonk67C3YF8+S7FU1Eu/38XidCiOOY6dxcVDrr0fOxCWLRTWl1/6WFwWiuO+y7M44mrBDz0NXYr77R6q8ku5OVqpZds20TgpdfBCpGFLrJu+qqu+KnbV7/GnG77hNfNXH6rXsu3oSPoYfF62IjRP1GFXldvxOGCLPFxehzw9Q1vPgSv27ana9WU7+jxUOOLbezVP0wjTG63kl6psi3bzUm2KXUKLDd8GHyHTO63wtqify6TULJTKfV1Warkr/CqmTwvPQ+Fc3zrs3j437W/dS1n2T027L/q+qp8jz9DBu7QVdk7vkjnltGURmRnIOs0Oa6akblPWW2KcXIvwu2e6bd9Hn6UQwXsRkjmIH/uXpiXmCBHOf9xh6Ng3/tFHjz1chTDf5rFv9kVfRX4hwpFRclefr+RnhQsEyXxfX6quOdhxMBoa7Jb14qcZ7xF9Kja/PbfNsd5uml08pppw7ZkzH/mnInaAcEkg1jwv+lTtdvbHlfXzrupeIq98DMd5plcO8rq+qLdFG8+WjzoUyFuTftoV9W/R2BkOnUwZTROtAUywUcp4H8qmOIyW7aEYWw6CJ6cvn5vWjtrxkjP0zeWyts2+qMiyKdxlMoeDQKIfoOPpMBylmFueQOJoj2KDZ8FHxPzRZU3skqtwRcccGzYvdopzJo0mIXti/PJi10yBVbuJ19RiFQ7Ia+bz2hVdZzv9Vr6FwsL1+WnuUrwRbLMrizY53a7C6Za3sHEChx2YixwAueGbVUzn2zVdua2KXRMN2zY5Kgg8sGUd493hY/iBCe6jO3bE2YJPgCmj2dknFU9Eq3AiYvo9nTLy4LGsxMkncqazNrvjPhouVoHLDxEIpZZI21av1bZso2kyMJHpW07UU1XutvF8K8Kl7CNvKeuFxUv6PJBjr6RbIKdvqnqzO27jOEs4VmjmnEYFfnojkbxchEKHxeqwy7eFAflq6K4wWgWdQnC2vL4Xzf2+mv3BLmSe2+Zz/9KS4ISMInOKt2XfNHVtY5p0j21zXC+zNXcYPQvrjvt90UZjqQpDmYq5BdiMt+s6nBDt9UFcOVV9bI5xyCkcEYZAGzMAuGmONRlf1uH4wrXrWPfxkCkfQzHct3is+/hx63AbrQ1TTlsWffla/V7ti2cwRYcPzF7xwZPZ2HXpJycbRzbCBaphPv6uO7TNoWz7ikQ5dbiMUMxv9ti2Zfw6w6VhxrTJSxmtuGw9oWBlw/zWj13f7OPgY/DwT9HbFdPNnDBv3yZ2k9C0JZZtbSTomW6pV+Fi9ZH78K08v4vterotVuFm1t5WzhdZH/ef4nWECX2DOQI5UYeytUvg4jleSge/lhn28uK6TVXWvcU+8fot9Nwl4sp/Hq28eHcjV2Eg7XGRwH/GO7fHLPwYeGPJmZpFNoW7NzmwKKVPbEcN2EflvLdzVuJ3FrGucCPN+/UXcXbeiQcEFW2Bs9OqQDPHhrPkXfHWHHtvbmRt4EvMKAmUGT+CLJjF5Wrhi4vEln1R7eJVnQrD8AOwsfkSN2h5HT31cNXADPkQYBvLC4P9OW/EmwbAOhzzzhzxOtGHpqvsJFnU2676vTweKIFS4fSmVgsdZUJJ0bZFNDOYcLC0SSxXaKKrYBWF9q+R+Fp11adqV/Vv++IQmytCc3l7qKTwEdQJWfHCR9FXPQlRhCs8rpv0USjcFtu8GCRPRNzW1eRK+1R0sVFZaBX7+fXFxLouHHyYET8rEQS0Q7CpV8PW7FEMYw5vKXoRbkEFCDArHY4OTPQcSKVeE74kvrCuObab+LsxYVhxfVr82cvRlsk81tuy3b1V9bP9N/QAwqWqZkafraze5hzEHhq+MiYBPUtqy2JL4qDh0lIzsZqTR15K+CjN6UkqlQ2PdMg7eTwN5IaJmKwqkA8SegB7xIuH/PDDzNjGlI4m0h+fhQs59jspu748HMq2aqKZT4evOGOu9q24vopzs7Lg1TID0tt4shLh8kkwie62eOviJVjwpCUzQrgtN9W+2G1eirbY0Nh9uGVTK+bg7AWScSlMMmPuILelHZo7ukXLwigRdwFRPhXHXQ+RnAqnXaZLlZjHhqsDZlDPimqrMSUKIbxe5cNHzRYKUp3COYgZl9mW3W99c4gn/zDoxB1h3eo7ihwH/s5d17sgf7GzY+tbcyijBxbm56yZb9HJ8/zg09uxi30/zNFhhtS8wH3ZdcVzOd4JhO6h1RIbTyLbclPaRIj4cwgRN3dCdVLR9Bn+as0MGHtpXf9GksPCD2vYbWqmA1dPT6WN9ZAAcbQj5v7WfVnTjB9hwnA2d1IaJLmOUcgukGaYUaht1W3aMp4powjsMLUzY+vbqjvsirfTRzJCa+HUkDNTJst609BBToUpFVrzljGDIJLOGebDrJZJouuCMIuTuYkoaxK3DrOMmeuzsn6t2qbejz71cBVqTqt8zYwJWeIa+1eY6GMrlvGktE27aWLuZMJMt4yZ7XqWFEO64HGtmU8rzKHeF7Ud0uLwfDhCMrdw5ZdDU4PgYYjsJDPkZ2XZpPy9BcqjzVCY2KIN17p+PPpEISGuZSc5ACiJMLopmBvys8A9cRERvgTBTE49S4u/8DAjTDPXVuWX3i5EfVCHLrRVGH7VzJHxqejifNkw7ieZ+1oHl+NvPExS02ckyvvGnbggsX+EW0NyLZjE2QkdRkgS5AvzejQzp87JI3LCj0DJ07Su1BAIz4dd5+MQ4xADfh6GwWz4l0zxnMubUdvcsA0JaoVbdOaqz0mjM7gKc8yUHIL4akiaEcOuWg7E28jh1wzHOoZnkDFJijOkbXajPa4w4ffMjDuNkx9UuO/WzCl/nL8VQpjV8C6Z+fReGozrBx+PZM79kbTR8lqHX7Vhbn69SJ8GN34N4WqMGT/2AuvjbteM9nQi3LkKJgrwAsFS3V7PGvxervNbaaNfGu4hRH76TpUcdp1DvocxanD6wdeZ2xiv9zSmjzJLwtAHE8o/VfX2ULTFvsSJ8uHnfDl4NYRbmTlwT9UX4rarMB7yyByVd00cDA7dgAmbnpq23NBpLPiCuEJsjPd0ZiEO84WzA3NJgjPmTRjIyockpHzITsmZBz8uwl12fuz4IfJnZgkSeSRLLEwVFHKwlOmJMHKuQvikmCHY56Lu+1F6drhTZa5jn8tmX5J8mlUwcTMH3Gfy4MMlf8Z8kc9l7w+LurD4OOdThafmNDNFzwqNDx3q8DBQxszB8WIudAFkpIYJQzlzae3FHopn9HPD16CZqbNW4Pm4FjBShXt7ZpDeyvQnmM5HYIC1YaxPqSFddAhNmAE/ZHJYDTHjO89lT3PtKugc4QLvkTdjPpc9waKjRMkwuKqY+2kndsJTVDjuMU8YWJlu7QGefBgwV8PjZaaBPJe932CMxIZhIKWGxeyZv2aPg6Lh1DITFjuNMFnc3kMfrFPYD9uLAz4RHiRTZphXmJPWc9m/VM8vu+r5JZ2GHlL+nBlmfC77XfNsDyy4gc66CnDnMLr6yB5AQ8HoIwkjcsxFyXPZ4x+vw/HYMCPzz2V/QPmWKjxjoZlTtROWWtnpsBaAYcblQ4nIocIEvfOQNuxkc+Yu9bnsZ043hPlXuWJ/CKdU5FP2d1U/NUB0eG6auSa/iIbOasL9lC0ttlwm2rWEyUaGP0wGUj1aB/aGB0w129f6ptn11cEG1YDMMKzMTPl+Lvs4TQF8sWHoSAzlIJi4ZSQfPubAIQz/YVwEp0cxE248c/6ED2QnX2W4IOfPQEQD+ATD5DNbqI0p+LXqjsUuqnQCZIcLACYYeSk6V4gjHjTDGCdz+nkpi54klIlwUyeY59FeSjszxsHqkGoPJz60HhYIzLNDL9WWMLMwmH76Apib//AQexzHCH9xzvPM8Yn42Mws/JB4I+tYJEyu0VH6NTNvJJS9K19twJeidXspfCB3+TN1cuPxJAxJGmbK8Fikmx/tWNWTFCERpgMKZgw9lH8o+pfY4HCdwIyyDALf0LHdMBXGMI+jvDTHeDMfAmzBXAtbISTNJ0y1Zm4JXhpbb+p42I1XaSb8wnMmD6FFpMIdlR5OAubDaDEko2l9Tv0bQutDG7MeNjnMoap6rpu2dMMnKcARrhH1mT8MKXKGOWV5+WefjZ0hXCQPgX/DnKnc2aQ4WBQuQJkyDrvS/ksqdTXMCmHmN5yOFRa7HTgCqcNkWMOcOk8Sz6NfB4LiYSKQGLIX9Rm4nBEMc0Y9qbQR+NdxBalVlIrIG82rGqehhbkoTJLu+0bfTTi5MhfZl3I44IBbuHbImZ/ypbwOTh7R4ZE+nXMfW122h7Z8qqJfLEJsKpnxPierOz6NZK1CWdxf2xxjfB7CAsEEKRU5bBdGH5mjgC1IUBe70bcbJtiIx9PmQDKXB1X9WuyqkCxD3inDjCXJnB5Psn3EanziPnyxgokbTyL9IilhafiO2c+Wih0tvmSYkSqZuSYnuedgQvTzw7XnMN9J5urrJPg82dAUahniBMlEh1Qofr7hIlQyczSo5BGjkeHySzLXi1Tq+J2FubqSeUCp6hKV/1R4QlzJYZ5hJvZU3abYbY67oi+3o9wQHcYo9VCp0DCLjFTdptl/qmooOIwcrIewLXcY7covbnakOT8qzCBScrCXiSesWJs3RWtnPUZbPL6JLv8njpeERyeYOdBV58ArTV8MIzoqZw4nZ1EolSFMJuK+4GebAVcQh9QyOiA90BbuvNY9l013KGginA6Lquj1OT+H+aV3L9V2G6da65A36fW5BgTXW/bNtnqqyG9fhysz9jfY/PNYtH1J90dRhVfuO24+l+VvRFA43rBfbvNmK93EgsLUe2ZuadUd7Paj7pv6cPxky2yVW3y6SofsSa/PmVfcAfIsPv7owl3UI/cptuUpcZvsD8O0MWY8suqCqG+8wQtHQeZh46rrm77Ytc1nV2xiV+0rOiGE5Uw1M4Oo6tyhS3J2LAyRKmaE7CwJ5kuF0ylL3G/Htm+6Kq4XEg5Wgjm874pPZXx0I3Bm5hHDXVE/H8muV4fzr2ZS2B1JggkjfswFgRURjWdZlP7Bk1EWvvx1XbxWz6mAcMh7mKHDXfkUL6TC6nyKOc/vymeS3B4dGucKeS1JWDEMejBX4kGIkoQTwiQe5uIAxSVDuMx1gOlYpDZhpIO51t5VNaniFh3lYP6+qi7j7B8ZxkUlMzBmM+wjIWEWh2TmEu+aTUEGtXCnoIaFhGbmAdm4Qlv1L/u4ZIgMh3LJfU4BD4/fXBijZX7K+6I+0rojYe4Fcxal8CVczwhmdWI7oEQDU7AkYguwgDgG+mHNGOaK1xHsUw06GvsMF+OGGQxy8oYvDs5voYsyJxUnlP5cFRa408zguL/I4LRHHGcWhyshw6xzPr4bIRYZIhrmqb2xSJLGGAJw5q7ByaTJi+GcwyxYZOWMEnvDhYJgHvrdF3GIL1z5CDWkJ4nhLIE8JyJzv/YvbfOZ4IIwJe+c66yGXTATiOyLL2PCFx5Cyh7P2dO8IXi/JUfEwwAb9/eWRXdsSV57GKlixhVPcsYh9bBAAPOAuDtdFUOAcOcrmBmMp0Ox0asMs0A1M5y+P9UejqfMcFfPPO2wr8iPCpcA6vzyz7l8q8F1mb+3qo+EmoYbccHMgPNiyPY0/LVMLLmvxgE6HS5XsuEIUMYsI7yvOktZxhA+PE0pmOGfkzAYqhWPUQEb5nNrtvEyISwewUxcoHE3HcbdNDNr2QrZlV30BsNxhkl99k0dI3MRRhEEk0M6KcSZwiUrE6c4MW9k8SvCPEzB3Lbsm9eyqLdtaStDkTxglPsXbtSZR632zWtVPxevZUuGHxlVWGAaTAPyKnx+Sp+GDTWAc5UPiPRxOFM/5Orq9fl41hA7HIqamSFKl2XDhLk+ycmZs5E1Ca3cwvU7z/Nqd53DaPBQ4ZJZc5+eo1yv5bjkkgoRhGIWgB3E+cqLY6EirI8gmSNHXX7uSn/2JA55hhU6mfvpmpz9DesIM+u/WxHRRJVHmes8GQ3Z7oa5rWJIiJDMe3KsNHw3U1Tflm0ahv8iXHMLJpOqrQvEu8MwliKZYR17eMOdggGkLBwzmHtWfL5Qh0c1s4HiZMwk29RDCyOGzABL+PUc66onS6swOs8sqe4lNk8oAhRub5lRxNN0EM8E4ckIZg2Ppt69xafqSHnmcAJj7qSszGCEJALDz4y53LZFhh286t66vowr8obl7TVz+muOPU7sCIE6Ey85WePEDhku0CQTLB3IbBwenGNuPq2IUV1sFb5FzZzjrCRwF0YEH5mCyEgbLtJ4Hw9cA+swB90wffMsCYZwwvd/pcBx7CWcnAwzjnaR2tR9G1/iEpGZhUb6zJe2tEWex3GxMIyQMUtTnEW7b50GUGT4eUrm9T6HwtbwhsWLTZh+mjN3ZV7eS0mSLOVjVO+XKyvecoQZ6swzsoftU7pgZxi5l8zl0KkydqriVCiR+8l6idWOiArXDVzX86KaJ8cuY3GhbzBDHb4E4tjNwi9XDqG1IQCWMdc4h4rUsgpHKmZxjkNDEuvC8zcnc5iRzUOze3smuabhAWbBPDxm5dTNflReKAxYc8elU93iGBWHsIG5dx8EoWE4CqQzpX0uW/fkJ76s0HmZm4TxGkGFCFExD7MfWovq7QnyUXXa8FACExq4XIcNrGsYRpmY1Ru9tM/lp3iKDsNLzODhP8m1fOGJPsEcLVwyjIjFhMt35ijhxKhYTBiFZ6Zv4NSccNRiJiD881htfgOLqaikKF+Sw4Y2eW80DkYl7JnbppbWwRfhOkjkp9iMZM62Ttz4WjYdDjcZc7YNruOMZYX32DHdM5CFjhuuogK4vNCNE0k2sGH4WA+wh3lzKqwXrMNdQKaHuY25v2vPt73FMsOVHvNUc0vuI5TRQM38pNryqS27F3CgNMxcYm4LwntV46hLOHwxk5fGl7TGTywstMwEFWOR0PPCD4N5RqQt7SkodFw9zEhiEjYr7LUgVymFjFwwc8Db0sau4zcRTgL5aT0mmfXFvLxL4RCQoBQSDO5X5qSS66zDpdACKVE9yDgYE47t2VA/c4hdmyF2nZ3rVQynyHLul10edsWGPO1wrlwNBy+YF9k4gW9FXe3xw1Yhq1NM6uqFdoeyHC/aVVTNmetirr7lUKyxLe2BaXsp244UotXhVKiZBVVbenRYhuO5Yq7bbUW8yJSQAunhzRtm4em2+RxtOMOrBdkS0B2FUZVMtiR0RWG4xWGGzdpjXdtT7uNNYfgpMusVdMUrOEgW1tPOmAcIu3LTkKK6YcRLcA1yYsi6MZwtmVMuPvQReuQCMXa31VZ92VZFPP+EiynmlVxnibggngxjVJI5oHmZLp3n09srvKDWhEc480W2gplXhutvyTwQ7aW5Y8ioOkOYwMSc5bpyX9R9tRkPG2EqyPpcypA3mndlvY1Kr4PKYCE1Y94dMRLbNz68BsSHZ7KZOQ9daeOJfdPiyxxC0qSYuaRd2b6S5Ik4Ar1EzCisIMIgohiAtmQmKXqhx7aK8XkYY2eeyO5oobswbYs5V3esgmrhw1NqOKkhz7z+nNc21MhlnrTuyn6zs5vbl7Y5Po93CDqsbq6ZOYzdqJLa5YIpsMAJfxrzSCnk4uFhGT2UYcrYI4yXWLyWVX1om+eWpMqIkD8KZkb9IBUmQISsisnkiLwx9ggPAWf8h/l7U5eT7yjMiWCmHHQvRTw/hXkaQ16JZAKP7qVoyy2uKC/DOhSSiXJBedAwKjjkxpjhrutsuKExy4f8u6HoQDYc1MyZmVhO92j2DtMr5ZCto87Vr8/3DDLPLXUv8RI2nMSHaydzZtzYyjpPEjH+DtGJYubhd64KRfwKw4+BeYzPZmpF/hUMJMNhNmXONUWG15adK7UNRWaZR7asPvAhR+MX8938Vn6u6fgSrt4Es6ZXt4tfsgzXzZK5Ne+afSKNJoxIMkv6dU3bb6t2nP8vw9iG5M4k7syiX/oc2xjIhjsNzQyEgXOuYXYP8zh/Z0PUBFqFJz6ZRQy6flu+xi4QPnBmuRknJSYS4cckuEuZvjzQD0qHh2wy5in0rm/iAsIyPEgimQc/nJTxBZJRthhTEL1YOYsWaTwhx09uz9zBi8CifF7mJzdKXVEhKVNMMNgd9/GLD5fF3BXg5awsXKWEXy0zHWYsEixUwvgrdxpyiUjoNu/oiCHT4Z2wXeNqIcaX3YRnbJgP0QkD925HRwIXiOpe7DhKDQtXKEseGb0OJTr9yPsgHf0qjqOtmA7TtzJmBbZBGPUKE+7rMmbiZijspai3u7J9quOXEMYHmKmSodTRUi2cM+QVZh7rtny28euRpWFQj5mIchLsFpXgiYa5ncwDYyeJr2VLbyDS4ZFQzQzvncSdt7fAyBCMMVPAfKlOP9LEwsIJnRmspVcj6egKlHenrQpT1ktz7AoaiAxPbEjm7Uj2syVFp6SJ8uaZ75POo+E8wQyu9g0djfKo+h9TyPMzXfiH8wtziDyV3o2nvnDm8/2YoaqTtKLevDTtKJHIhB6fMdORTiLBnVsmTM3LmNN8VIAiBo+hn8rzwQ6ulcklTXQsiDfp95YK0ePsYdrOMinutNJo4A3BpmSezejbY72h1+aGIQPBpGBO0Kg0Z1itQTDPfDpJ4FyejryY+RadrNGhrHC7L5gbQSeKJhSFwXXBhApOEKA6YfU4wQQJTpYtsRNLCjfLzJC/kzQ6LBYWlBBMaOtAREVgdhg/Pt90wTzgN3L0cFWlhjCvGgoeq+x8qmuoizqkqGgzFPcahgOTDxBjdb7ae4iFPA4hLHE+5zUEkAfJ2XDrfLY6HwEbKo8PNVJz5hGAYxXPQmFIaiDxGTO/0hbtfrLFzuL4R7jXZAZRjnX1z2Np7/GNX6kOM/s0M5w/OreiwhlbMSeQY/1b3XyO4yfR0YbhJfn/FcxI70ksDPaEU4lgLhSPdXc8+Ksv3aLO9Y9i5uHgyAT5gdB92b8026emvdSvGhULCJd7gsnB6Z3NIjwMJJgbyFF+lwoDkPpc3ff8RTEHl9fR8R0VHmtRzGjlKxnnwiosgrmtfS3aeJUVno0UzNXaa1V+JiEYES3XmPV0L3wC8MBwtmOe+wHF+WOSGh56YB7ZfK1+hze3ijBYKZlY9rX63ZV8Tt1dLPMogYr7FL3QQ7Ere5BDsIoSHXhT9CDTxg9PhKrYVc/ueuOxgnBNyH+sVMFYbjjMMseBs9wwaD2ei8NHwkyS/Fx+oufKdHQcjCmFLHvCOJdghoCsELr8DUNcghkBAmUOQ/9joo/P1TZeqapwAa2GxYbW53UIb5T5XNXbmIWENSWYUWcbovjUNL/Fq5Sw1sKZGTEHmUEivvRQhxn/OhtyEbk+NpINA7ghHGUelkpKHoduwmVJzozJD+LHtcJ0mOegmaD5HFiKXTz08JNTDdB5WNuq1XmxPOQHDheVZMOfsqGgaj7Uls/N4ATMANjZQBcQIIHwMO9E58OCmrlWOEtOXKoZbrhy5qQPZEK/CokXM8yWFj12rHCHl3OHukE+XYiqMOyihnJQZrhd1AzXwWXnU2zcEfqcsxOpC9Ng1dJ3OcZe0b3OLGExWwrjCmq4jDljTpJvsaiQ958zIJij4WjzbaKvlC/EXkpi//e5bT7H04kMcbxkMtRx4d1ot8UstPTWb5E94fjLhLFv/XacoxsmJkom3IvzekitQRNmnOTMw3mxRLpWMuHd1/l5suTEqf/x/t2hOpQugviHX//xv//7/wPKJ5e7"; \ No newline at end of file diff --git a/website/static/api/assets/style.css b/website/static/api/assets/style.css new file mode 100644 index 00000000..5ba5a2a9 --- /dev/null +++ b/website/static/api/assets/style.css @@ -0,0 +1,1633 @@ +@layer typedoc { + :root { + --dim-toolbar-contents-height: 2.5rem; + --dim-toolbar-border-bottom-width: 1px; + --dim-header-height: calc( + var(--dim-toolbar-border-bottom-width) + + var(--dim-toolbar-contents-height) + ); + + /* 0rem For mobile; unit is required for calculation in `calc` */ + --dim-container-main-margin-y: 0rem; + + --dim-footer-height: 3.5rem; + + --modal-animation-duration: 0.2s; + } + + :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --light-color-background-active: #d6d8da; + --light-color-background-warning: #e6e600; + --light-color-warning-text: #222; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-background-active); + --light-color-text: #222; + --light-color-contrast-text: #000; + --light-color-text-aside: #5e5e5e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + } + + :root { + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --dark-color-background-active: #5d5d6a; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: var(--dark-color-background-active); + --dark-color-text: #f5f5f5; + --dark-color-contrast-text: #ffffff; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + :root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + + :root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + + html { + color-scheme: var(--color-scheme); + @media (prefers-reduced-motion: no-preference) { + scroll-behavior: smooth; + } + } + + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } + + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } + + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } + + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } + + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } + + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } + + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } + + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } + + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } + + dl, + menu, + ol, + ul { + margin: 1em 0; + } + + dd { + margin: 0 0 0 34px; + } + + .container { + max-width: 1700px; + padding: 0 2rem; + } + + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: var(--dim-footer-height); + } + footer > p { + margin: 0 1em; + } + + .container-main { + margin: var(--dim-container-main-margin-y) auto; + /* toolbar, footer, margin */ + min-height: calc( + 100svh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + } + + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: + -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + margin: 0; + } + + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + :target { + scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); + } + + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } + + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; + } + pre:hover > button, + pre > button.visible, + pre > button:focus-visible { + opacity: 1; + } + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; + } + + img { + max-width: 100%; + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + dialog { + border: none; + outline: none; + padding: 0; + background-color: var(--color-background); + } + dialog::backdrop { + display: none; + } + #tsd-overlay { + background-color: rgba(0, 0, 0, 0.5); + position: fixed; + z-index: 9999; + top: 0; + left: 0; + right: 0; + bottom: 0; + animation: fade-in var(--modal-animation-duration) forwards; + } + #tsd-overlay.closing { + animation-name: fade-out; + } + + .tsd-typography { + line-height: 1.333em; + } + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); + } + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } + + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } + + .tsd-breadcrumb { + margin: 0; + margin-top: 1rem; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } + + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } + + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } + + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } + + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } + + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } + + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } + + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } + + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } + + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } + + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } + + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } + + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } + + .tsd-anchor { + position: relative; + top: -100px; + } + + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } + + .tsd-navigation.settings { + margin: 0; + margin-bottom: 1rem; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + color: var(--color-contrast-text); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } + + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > summary > svg { + margin-right: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 30px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } + + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } + + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + display: flex; + align-items: center; + gap: 0.25rem; + box-sizing: border-box; + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + /* + * We need to be careful to target the arrow indicating whether the accordion + * is open, but not any other SVGs included in the details element. + */ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-summary { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + display: flex; + align-content: center; + } + + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } + + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } + + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } + + #tsd-search[open] { + animation: fade-in var(--modal-animation-duration) ease-out forwards; + } + #tsd-search[open].closing { + animation-name: fade-out; + } + + /* Avoid setting `display` on closed dialog */ + #tsd-search[open] { + display: flex; + flex-direction: column; + padding: 1rem; + width: 32rem; + max-width: 90vw; + max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); + /* Anchor dialog to top */ + margin-top: 10vh; + border-radius: 6px; + will-change: max-height; + } + #tsd-search-input { + box-sizing: border-box; + width: 100%; + padding: 0 0.625rem; /* 10px */ + outline: 0; + border: 2px solid var(--color-accent); + background-color: transparent; + color: var(--color-text); + border-radius: 4px; + height: 2.5rem; + flex: 0 0 auto; + font-size: 0.875rem; + transition: border-color 0.2s, background-color 0.2s; + } + #tsd-search-input:focus-visible { + background-color: var(--color-background-active); + border-color: transparent; + color: var(--color-contrast-text); + } + #tsd-search-input::placeholder { + color: inherit; + opacity: 0.8; + } + #tsd-search-results { + margin: 0; + padding: 0; + list-style: none; + flex: 1 1 auto; + display: flex; + flex-direction: column; + overflow-y: auto; + } + #tsd-search-results:not(:empty) { + margin-top: 0.5rem; + } + #tsd-search-results > li { + background-color: var(--color-background); + line-height: 1.5; + box-sizing: border-box; + border-radius: 4px; + } + #tsd-search-results > li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search-results > li:is(:hover, [aria-selected="true"]) { + background-color: var(--color-background-active); + color: var(--color-contrast-text); + } + /* It's important that this takes full size of parent `li`, to capture a click on `li` */ + #tsd-search-results > li > a { + display: flex; + align-items: center; + padding: 0.5rem 0.25rem; + box-sizing: border-box; + width: 100%; + } + #tsd-search-results > li > a > .text { + flex: 1 1 auto; + min-width: 0; + overflow-wrap: anywhere; + } + #tsd-search-results > li > a .parent { + color: var(--color-text-aside); + } + #tsd-search-results > li > a mark { + color: inherit; + background-color: inherit; + font-weight: bold; + } + #tsd-search-status { + flex: 1; + display: grid; + place-content: center; + text-align: center; + overflow-wrap: anywhere; + } + #tsd-search-status:not(:empty) { + min-height: 6rem; + } + + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } + + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } + + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } + + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } + + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } + + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } + + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: var(--dim-toolbar-border-bottom-width) + var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + } + .tsd-toolbar-contents { + display: flex; + align-items: center; + height: var(--dim-toolbar-contents-height); + margin: 0 auto; + } + .tsd-toolbar-contents > .title { + font-weight: bold; + margin-right: auto; + } + #tsd-toolbar-links { + display: flex; + align-items: center; + gap: 1.5rem; + margin-right: 1rem; + } + + .tsd-widget { + box-sizing: border-box; + display: inline-block; + opacity: 0.8; + height: 2.5rem; + width: 2.5rem; + transition: opacity 0.1s, background-color 0.1s; + text-align: center; + cursor: pointer; + border: none; + background-color: transparent; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget:active { + opacity: 1; + background-color: var(--color-accent); + } + #tsd-toolbar-menu-trigger { + display: none; + } + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; + } + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + vertical-align: middle; + } + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; + } + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg, + .tsd-anchor-icon:focus-visible svg { + visibility: visible; + } + + .deprecated { + text-decoration: line-through !important; + } + + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); + } + + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); + } + + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); + } + + /* mobile */ + @media (max-width: 769px) { + #tsd-toolbar-menu-trigger { + display: inline-block; + /* temporary fix to vertically align, for compatibility */ + line-height: 2.5; + } + #tsd-toolbar-links { + display: none; + } + + .container-main { + display: flex; + } + .col-content { + float: none; + max-width: 100%; + width: 100%; + } + .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + .col-sidebar > *:last-child { + padding-bottom: 20px; + } + .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + --dim-container-main-margin-y: 2rem; + } + + .tsd-breadcrumb { + margin-top: 0; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: + minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 0rem; + } + + .page-menu, + .site-menu { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } + } +} diff --git a/website/static/api/enums/AnalyticsObjectType.html b/website/static/api/enums/AnalyticsObjectType.html new file mode 100644 index 00000000..eec01b7d --- /dev/null +++ b/website/static/api/enums/AnalyticsObjectType.html @@ -0,0 +1,28 @@ +AnalyticsObjectType | Tableau Extensions API
    Tableau Extensions API
      Preparing search index...

      Enumeration AnalyticsObjectType

      Index

      Enumeration Members

      Cluster +Forecast +TrendLine +

      Enumeration Members

      Cluster: "cluster"
      Forecast: "forecast"
      TrendLine: "trend-line"

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      diff --git a/website/static/api/enums/AnnotationType.html b/website/static/api/enums/AnnotationType.html new file mode 100644 index 00000000..4c593eb1 --- /dev/null +++ b/website/static/api/enums/AnnotationType.html @@ -0,0 +1,28 @@ +AnnotationType | Tableau Extensions API
      Tableau Extensions API
        Preparing search index...

        Enumeration AnnotationType

        Index

        Enumeration Members

        Area +Mark +Point +

        Enumeration Members

        Area: "area"
        Mark: "mark"
        Point: "point"

        Settings

        Member Visibility

        On This Page

        Enumeration Members
        diff --git a/website/static/api/enums/ClassNameKey.html b/website/static/api/enums/ClassNameKey.html new file mode 100644 index 00000000..b735b06b --- /dev/null +++ b/website/static/api/enums/ClassNameKey.html @@ -0,0 +1,33 @@ +ClassNameKey | Tableau Extensions API
        Tableau Extensions API
          Preparing search index...

          Enumeration ClassNameKey

          Index

          Enumeration Members

          ColumnDividers +DashboardTitle +Pane +RowDividers +StoryTitle +Tooltip +Worksheet +WorksheetTitle +

          Enumeration Members

          ColumnDividers: "tableau-column-dividers"
          DashboardTitle: "tableau-dashboard-title"
          Pane: "tableau-pane"
          RowDividers: "tableau-row-dividers"
          StoryTitle: "tableau-story-title"
          Tooltip: "tableau-tooltip"
          Worksheet: "tableau-worksheet"
          WorksheetTitle: "tableau-worksheet-title"

          Settings

          Member Visibility

          On This Page

          Enumeration Members
          diff --git a/website/static/api/enums/ColumnType.html b/website/static/api/enums/ColumnType.html new file mode 100644 index 00000000..d393bc4d --- /dev/null +++ b/website/static/api/enums/ColumnType.html @@ -0,0 +1,28 @@ +ColumnType | Tableau Extensions API
          Tableau Extensions API
            Preparing search index...

            Enumeration ColumnType

            Index

            Enumeration Members

            Continuous +Discrete +Unknown +

            Enumeration Members

            Continuous: "continuous"
            Discrete: "discrete"
            Unknown: "unknown"

            Settings

            Member Visibility

            On This Page

            Enumeration Members
            diff --git a/website/static/api/enums/DashboardLayoutChange.html b/website/static/api/enums/DashboardLayoutChange.html new file mode 100644 index 00000000..e63df230 --- /dev/null +++ b/website/static/api/enums/DashboardLayoutChange.html @@ -0,0 +1,46 @@ +DashboardLayoutChange | Tableau Extensions API
            Tableau Extensions API
              Preparing search index...

              Enumeration DashboardLayoutChange

              Enum that represents the changes that occur to a dashboard object.

              +
              Index

              Enumeration Members

              Added +DashboardChanged +Deselected +IsFloatingChanged +IsVisibleChanged +NameChanged +PositionChanged +Removed +Selected +SizeChanged +

              Enumeration Members

              Added: "added"

              A dashboard object was added

              +
              DashboardChanged: "dashboard-changed"

              Navigate to another dashboard

              +
              Deselected: "deselected"

              A dashboard object is deselected

              +
              IsFloatingChanged: "is-floating-changed"

              A dashboard object's floating state changed

              +
              IsVisibleChanged: "is-visible-changed"

              A dashboard object's visibility changed

              +
              NameChanged: "name-changed"

              A dashboard object was renamed

              +
              PositionChanged: "position-changed"

              A dashboard object's position changed

              +
              Removed: "removed"

              A dashboard object was removed

              +
              Selected: "selected"

              A dashboard object is selected

              +
              SizeChanged: "size-changed"

              A dashboard object's size changed

              +

              Settings

              Member Visibility

              On This Page

              Enumeration Members
              diff --git a/website/static/api/enums/DashboardObjectType.html b/website/static/api/enums/DashboardObjectType.html new file mode 100644 index 00000000..101e45a6 --- /dev/null +++ b/website/static/api/enums/DashboardObjectType.html @@ -0,0 +1,37 @@ +DashboardObjectType | Tableau Extensions API
              Tableau Extensions API
                Preparing search index...

                Enumeration DashboardObjectType

                What the object represents in a dashboard.

                +
                Index

                Enumeration Members

                Blank +Extension +Image +Legend +PageFilter +ParameterControl +QuickFilter +Text +Title +WebPage +Worksheet +

                Enumeration Members

                Blank: "blank"
                Extension: "extension"
                Image: "image"
                Legend: "legend"
                PageFilter: "page-filter"
                ParameterControl: "parameter-control"
                QuickFilter: "quick-filter"

                Text

                Text: "text"
                Title: "title"
                WebPage: "web-page"
                Worksheet: "worksheet"

                Settings

                Member Visibility

                On This Page

                Enumeration Members
                diff --git a/website/static/api/enums/DashboardObjectVisibilityType.html b/website/static/api/enums/DashboardObjectVisibilityType.html new file mode 100644 index 00000000..2efcd0b9 --- /dev/null +++ b/website/static/api/enums/DashboardObjectVisibilityType.html @@ -0,0 +1,31 @@ +DashboardObjectVisibilityType | Tableau Extensions API
                Tableau Extensions API
                  Preparing search index...

                  Enumeration DashboardObjectVisibilityType

                  Enum that represents the visibility state of a dashboard object.

                  +

                  1.7.0

                  +
                  Index

                  Enumeration Members

                  Hide +Show +

                  Enumeration Members

                  Hide: "hide"

                  Used for turning off the visibility of a dashboard object.

                  +
                  Show: "show"

                  Used for turning on the visibility of a dashboard object.

                  +

                  Settings

                  Member Visibility

                  On This Page

                  Enumeration Members
                  diff --git a/website/static/api/enums/DataFormatType.html b/website/static/api/enums/DataFormatType.html new file mode 100644 index 00000000..7c89d7c6 --- /dev/null +++ b/website/static/api/enums/DataFormatType.html @@ -0,0 +1,36 @@ +DataFormatType | Tableau Extensions API
                  Tableau Extensions API
                    Preparing search index...

                    Enumeration DataFormatType

                    Index

                    Enumeration Members

                    AutoFormat +Custom +CustomCurrency +CustomNumber +CustomPercentage +CustomScientific +SystemCurrency +SystemLongDate +SystemNumber +SystemShortDate +SystemTime +

                    Enumeration Members

                    AutoFormat: "auto-format"
                    Custom: "custom"
                    CustomCurrency: "custom-currency"
                    CustomNumber: "custom-number"
                    CustomPercentage: "custom-percentage"
                    CustomScientific: "custom-scientific"
                    SystemCurrency: "system-currency"
                    SystemLongDate: "system-long-date"
                    SystemNumber: "system-number"
                    SystemShortDate: "system-short-date"
                    SystemTime: "system-time"

                    Settings

                    Member Visibility

                    On This Page

                    Enumeration Members
                    diff --git a/website/static/api/enums/DataType.html b/website/static/api/enums/DataType.html new file mode 100644 index 00000000..b300f18c --- /dev/null +++ b/website/static/api/enums/DataType.html @@ -0,0 +1,34 @@ +DataType | Tableau Extensions API
                    Tableau Extensions API
                      Preparing search index...

                      Enumeration DataType

                      The different types of data a value can have

                      +
                      Index

                      Enumeration Members

                      Bool +Date +DateTime +Float +Int +Spatial +String +Unknown +

                      Enumeration Members

                      Bool: "bool"
                      Date: "date"
                      DateTime: "date-time"
                      Float: "float"
                      Int: "int"
                      Spatial: "spatial"
                      String: "string"
                      Unknown: "unknown"

                      Settings

                      Member Visibility

                      On This Page

                      Enumeration Members
                      diff --git a/website/static/api/enums/DateRangeType.html b/website/static/api/enums/DateRangeType.html new file mode 100644 index 00000000..9f540fb1 --- /dev/null +++ b/website/static/api/enums/DateRangeType.html @@ -0,0 +1,32 @@ +DateRangeType | Tableau Extensions API
                      Tableau Extensions API
                        Preparing search index...

                        Enumeration DateRangeType

                        Valid date ranges for a relative date filter.

                        +
                        Index

                        Enumeration Members

                        Current +Last +LastN +Next +NextN +ToDate +

                        Enumeration Members

                        Current: "current"
                        Last: "last"
                        LastN: "last-n"
                        Next: "next"
                        NextN: "next-n"
                        ToDate: "to-date"

                        Settings

                        Member Visibility

                        On This Page

                        Enumeration Members
                        diff --git a/website/static/api/enums/DialogStyle.html b/website/static/api/enums/DialogStyle.html new file mode 100644 index 00000000..16785dc2 --- /dev/null +++ b/website/static/api/enums/DialogStyle.html @@ -0,0 +1,29 @@ +DialogStyle | Tableau Extensions API
                        Tableau Extensions API
                          Preparing search index...

                          Enumeration DialogStyle

                          Enum that represents the types of dialog popup styles.

                          +
                          Index

                          Enumeration Members

                          Modal +Modeless +Window +

                          Enumeration Members

                          Modal: "modal"
                          Modeless: "modeless"
                          Window: "window"

                          Settings

                          Member Visibility

                          On This Page

                          Enumeration Members
                          diff --git a/website/static/api/enums/EncodingType.html b/website/static/api/enums/EncodingType.html new file mode 100644 index 00000000..88a5dd0e --- /dev/null +++ b/website/static/api/enums/EncodingType.html @@ -0,0 +1,41 @@ +EncodingType | Tableau Extensions API
                          Tableau Extensions API
                            Preparing search index...

                            Enumeration EncodingType

                            Index

                            Enumeration Members

                            Angle +Color +Column +Custom +Detail +Filter +Geometry +Label +MarksType +MeasureValues +Page +Path +Row +Shape +Size +Tooltip +

                            Enumeration Members

                            Angle: "angle"
                            Color: "color"
                            Column: "column"
                            Custom: "custom"
                            Detail: "detail"
                            Filter: "filter"
                            Geometry: "geometry"
                            Label: "label"
                            MarksType: "marks-type"
                            MeasureValues: "measure-values"

                            Page

                            Page: "page"
                            Path: "path"
                            Row: "row"
                            Shape: "shape"
                            Size: "size"
                            Tooltip: "tooltip"

                            Settings

                            Member Visibility

                            On This Page

                            Enumeration Members
                            diff --git a/website/static/api/enums/ErrorCodes.html b/website/static/api/enums/ErrorCodes.html new file mode 100644 index 00000000..819503b2 --- /dev/null +++ b/website/static/api/enums/ErrorCodes.html @@ -0,0 +1,52 @@ +ErrorCodes | Tableau Extensions API
                            Tableau Extensions API
                              Preparing search index...

                              Enumeration ErrorCodes

                              All error codes used by the Extensions API.

                              +
                              Index

                              Enumeration Members

                              APINotInitialized +DialogAlreadyOpen +DialogClosedByUser +InternalError +InvalidDomainDialog +InvalidParameter +MissingFilter +MissingParameter +ServerError +SettingSaveInProgress +UnsupportedEventName +UnsupportedMethodForDataSourceType +VisibilityError +

                              Enumeration Members

                              APINotInitialized: "api-not-initialized"

                              Thrown when caller attempts to execute command before initialization has completed.

                              +
                              DialogAlreadyOpen: "dialog-already-open"

                              Only one dialog can be opened at time with the UI namespace functionality.

                              +
                              DialogClosedByUser: "dialog-closed-by-user"

                              The open dialog was closed by the user.

                              +
                              InternalError: "internal-error"

                              An error occurred within the Tableau Extensions API. Contact Tableau Support.

                              +
                              InvalidDomainDialog: "invalid-dialog-domain"

                              A dialog must start on the same domain as the parent extension.

                              +
                              InvalidParameter: "invalid-parameter"

                              A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.

                              +
                              MissingFilter: "missing-filter"

                              Can occur if the extension interacts with a filter that has been removed from the worksheet.

                              +
                              MissingParameter: "missing-parameter"

                              Can occur if the extension interacts with a parameter that has been removed from the worksheet.

                              +
                              ServerError: "server-error"

                              Internal Server Error

                              +
                              SettingSaveInProgress: "setting-save-in-progress"

                              Developer cannot save settings while another save is still in progress.

                              +
                              UnsupportedEventName: "unsupported-event-name"

                              An unknown event name was specified in the call to addEventListener or removeEventListener.

                              +
                              UnsupportedMethodForDataSourceType: "unsupported-method-for-data-source-type"

                              A method was used for a type of data source that doesn't support that method (see getActiveTablesAsync for an example)

                              +
                              VisibilityError: "visibility-error"

                              Thrown when caller attempts to execute command while extension is not visible.

                              +

                              Settings

                              Member Visibility

                              On This Page

                              Enumeration Members
                              diff --git a/website/static/api/enums/ExtensionContext.html b/website/static/api/enums/ExtensionContext.html new file mode 100644 index 00000000..471ca83f --- /dev/null +++ b/website/static/api/enums/ExtensionContext.html @@ -0,0 +1,31 @@ +ExtensionContext | Tableau Extensions API
                              Tableau Extensions API
                                Preparing search index...

                                Enumeration ExtensionContext

                                The context in which the Extensions is currently running.

                                +
                                Index

                                Enumeration Members

                                Cloud +Desktop +PublicDesktop +PublicWeb +Server +

                                Enumeration Members

                                Cloud: "cloud"
                                Desktop: "desktop"
                                PublicDesktop: "public-desktop"
                                PublicWeb: "public-web"
                                Server: "server"

                                Settings

                                Member Visibility

                                On This Page

                                Enumeration Members
                                diff --git a/website/static/api/enums/ExtensionMode.html b/website/static/api/enums/ExtensionMode.html new file mode 100644 index 00000000..310f57c5 --- /dev/null +++ b/website/static/api/enums/ExtensionMode.html @@ -0,0 +1,28 @@ +ExtensionMode | Tableau Extensions API
                                Tableau Extensions API
                                  Preparing search index...

                                  Enumeration ExtensionMode

                                  The mode in which the Extensions is currently running.

                                  +
                                  Index

                                  Enumeration Members

                                  Authoring +Viewing +

                                  Enumeration Members

                                  Authoring: "authoring"
                                  Viewing: "viewing"

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Enumeration Members
                                  diff --git a/website/static/api/enums/FieldAggregationType.html b/website/static/api/enums/FieldAggregationType.html new file mode 100644 index 00000000..99ee5159 --- /dev/null +++ b/website/static/api/enums/FieldAggregationType.html @@ -0,0 +1,66 @@ +FieldAggregationType | Tableau Extensions API
                                  Tableau Extensions API
                                    Preparing search index...

                                    Enumeration FieldAggregationType

                                    Type of aggregation on a field.

                                    +
                                    Index

                                    Enumeration Members

                                    Attr +Avg +Collect +Count +Countd +Day +End +Hour +InOut +Kurtosis +Max +Mdy +Median +Min +Minute +Month +MonthYear +None +Qtr +Quart1 +Quart3 +Second +Skewness +Stdev +Stdevp +Sum +TruncDay +TruncHour +TruncMinute +TruncMonth +TruncQtr +TruncSecond +TruncWeek +TruncYear +User +Var +Varp +Week +Weekday +Year +

                                    Enumeration Members

                                    Attr: "attr"
                                    Avg: "avg"
                                    Collect: "collect"
                                    Count: "count"
                                    Countd: "countd"
                                    Day: "day"
                                    End: "end"
                                    Hour: "hour"
                                    InOut: "in-out"
                                    Kurtosis: "kurtosis"
                                    Max: "max"
                                    Mdy: "mdy"
                                    Median: "median"
                                    Min: "min"
                                    Minute: "minute"
                                    Month: "month"
                                    MonthYear: "month-year"
                                    None: "none"
                                    Qtr: "qtr"
                                    Quart1: "quart1"
                                    Quart3: "quart3"
                                    Second: "second"
                                    Skewness: "skewness"
                                    Stdev: "stdev"
                                    Stdevp: "stdevp"
                                    Sum: "sum"
                                    TruncDay: "trunc-day"
                                    TruncHour: "trunc-hour"
                                    TruncMinute: "trunc-minute"
                                    TruncMonth: "trunc-month"
                                    TruncQtr: "trunc-qtr"
                                    TruncSecond: "trunc-second"
                                    TruncWeek: "trunc-week"
                                    TruncYear: "trunc-year"
                                    User: "user"
                                    Var: "var"
                                    Varp: "varp"
                                    Week: "week"
                                    Weekday: "weekday"
                                    Year: "year"

                                    Settings

                                    Member Visibility

                                    On This Page

                                    Enumeration Members
                                    diff --git a/website/static/api/enums/FieldRoleType.html b/website/static/api/enums/FieldRoleType.html new file mode 100644 index 00000000..2bb8ddd6 --- /dev/null +++ b/website/static/api/enums/FieldRoleType.html @@ -0,0 +1,29 @@ +FieldRoleType | Tableau Extensions API
                                    Tableau Extensions API
                                      Preparing search index...

                                      Enumeration FieldRoleType

                                      Role of a field.

                                      +
                                      Index

                                      Enumeration Members

                                      Dimension +Measure +Unknown +

                                      Enumeration Members

                                      Dimension: "dimension"
                                      Measure: "measure"
                                      Unknown: "unknown"

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Enumeration Members
                                      diff --git a/website/static/api/enums/FilterDomainType.html b/website/static/api/enums/FilterDomainType.html new file mode 100644 index 00000000..56aa885e --- /dev/null +++ b/website/static/api/enums/FilterDomainType.html @@ -0,0 +1,31 @@ +FilterDomainType | Tableau Extensions API
                                      Tableau Extensions API
                                        Preparing search index...

                                        Enumeration FilterDomainType

                                        The domain type for a filter

                                        +
                                        Index

                                        Enumeration Members

                                        Database +Relevant +

                                        Enumeration Members

                                        Database: "database"

                                        list of all possible domain values from database

                                        +
                                        Relevant: "relevant"

                                        The domain values that are relevant to the specified filter +i.e. the domain is restricted by a previous filter

                                        +

                                        Settings

                                        Member Visibility

                                        On This Page

                                        Enumeration Members
                                        diff --git a/website/static/api/enums/FilterNullOption.html b/website/static/api/enums/FilterNullOption.html new file mode 100644 index 00000000..8854f09a --- /dev/null +++ b/website/static/api/enums/FilterNullOption.html @@ -0,0 +1,30 @@ +FilterNullOption | Tableau Extensions API
                                        Tableau Extensions API
                                          Preparing search index...

                                          Enumeration FilterNullOption

                                          The option for specifying which values to include for filtering +Indicates what to do with null values for a given filter or mark selection call.

                                          +
                                          Index

                                          Enumeration Members

                                          AllValues +NonNullValues +NullValues +

                                          Enumeration Members

                                          AllValues: "all-values"
                                          NonNullValues: "non-null-values"
                                          NullValues: "null-values"

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Enumeration Members
                                          diff --git a/website/static/api/enums/FilterType.html b/website/static/api/enums/FilterType.html new file mode 100644 index 00000000..79a4b550 --- /dev/null +++ b/website/static/api/enums/FilterType.html @@ -0,0 +1,30 @@ +FilterType | Tableau Extensions API
                                          Tableau Extensions API
                                            Preparing search index...

                                            Enumeration FilterType

                                            An enumeration of the valid types of filters that can be applied.

                                            +
                                            Index

                                            Enumeration Members

                                            Categorical +Hierarchical +Range +RelativeDate +

                                            Enumeration Members

                                            Categorical: "categorical"
                                            Hierarchical: "hierarchical"
                                            Range: "range"
                                            RelativeDate: "relative-date"

                                            Settings

                                            Member Visibility

                                            On This Page

                                            Enumeration Members
                                            diff --git a/website/static/api/enums/FilterUpdateType.html b/website/static/api/enums/FilterUpdateType.html new file mode 100644 index 00000000..1f60800c --- /dev/null +++ b/website/static/api/enums/FilterUpdateType.html @@ -0,0 +1,30 @@ +FilterUpdateType | Tableau Extensions API
                                            Tableau Extensions API
                                              Preparing search index...

                                              Enumeration FilterUpdateType

                                              The different update types for applying filter

                                              +
                                              Index

                                              Enumeration Members

                                              Add +All +Remove +Replace +

                                              Enumeration Members

                                              Add: "add"
                                              All: "all"
                                              Remove: "remove"
                                              Replace: "replace"

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Enumeration Members
                                              diff --git a/website/static/api/enums/HierarchicalLevelSelectionState.html b/website/static/api/enums/HierarchicalLevelSelectionState.html new file mode 100644 index 00000000..adfbdd25 --- /dev/null +++ b/website/static/api/enums/HierarchicalLevelSelectionState.html @@ -0,0 +1,31 @@ +HierarchicalLevelSelectionState | Tableau Extensions API
                                              Tableau Extensions API
                                                Preparing search index...

                                                Enumeration HierarchicalLevelSelectionState

                                                Enum that represents the selection state of a level in a hierarchical filter

                                                +

                                                Extensions 1.10.0

                                                +
                                                Index

                                                Enumeration Members

                                                AllSelected +NoneSelected +SomeSelected +UnknownSelected +

                                                Enumeration Members

                                                AllSelected: "all-selected"
                                                NoneSelected: "none-selected"
                                                SomeSelected: "some-selected"
                                                UnknownSelected: "unknown-selected"

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Enumeration Members
                                                diff --git a/website/static/api/enums/IncludeDataValuesOption.html b/website/static/api/enums/IncludeDataValuesOption.html new file mode 100644 index 00000000..37c10791 --- /dev/null +++ b/website/static/api/enums/IncludeDataValuesOption.html @@ -0,0 +1,37 @@ +IncludeDataValuesOption | Tableau Extensions API
                                                Tableau Extensions API
                                                  Preparing search index...

                                                  Enumeration IncludeDataValuesOption

                                                  Enum that serves as a filter on the DataValues returned from getSummaryDataReaderAsync, +getUnderlyingTableDataReaderAsync and getLogicalTableDataReaderAsync. +This is an optimization of returned data values only. Tableau versions prior to 2021.2 +will pass the data across and populate the DataValue properties. +Please note that all properties not requested will be undefined in the DataValue results.

                                                  +

                                                  1.5.0

                                                  +
                                                  Index

                                                  Enumeration Members

                                                  AllValues +OnlyFormattedValues +OnlyNativeValues +

                                                  Enumeration Members

                                                  AllValues: "all-values"

                                                  DataValues will include all properties.

                                                  +
                                                  OnlyFormattedValues: "only-formatted-values"

                                                  DataValues will only include formattedValue properties.

                                                  +
                                                  OnlyNativeValues: "only-native-values"

                                                  DataValues will only include value and nativeValue properties.

                                                  +

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Enumeration Members
                                                  diff --git a/website/static/api/enums/MarkType.html b/website/static/api/enums/MarkType.html new file mode 100644 index 00000000..2c447051 --- /dev/null +++ b/website/static/api/enums/MarkType.html @@ -0,0 +1,39 @@ +MarkType | Tableau Extensions API
                                                  Tableau Extensions API
                                                    Preparing search index...

                                                    Enumeration MarkType

                                                    Type of mark for a given marks card in a viz.

                                                    +
                                                    Index

                                                    Enumeration Members

                                                    Area +Bar +Circle +GanttBar +Heatmap +Line +Map +Pie +Polygon +Shape +Square +Text +VizExtension +

                                                    Enumeration Members

                                                    Area: "area"
                                                    Bar: "bar"
                                                    Circle: "circle"
                                                    GanttBar: "gantt-bar"
                                                    Heatmap: "heatmap"
                                                    Line: "line"
                                                    Map: "map"
                                                    Pie: "pie"
                                                    Polygon: "polygon"
                                                    Shape: "shape"
                                                    Square: "square"

                                                    Text

                                                    Text: "text"
                                                    VizExtension: "viz-extension"

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Enumeration Members
                                                    diff --git a/website/static/api/enums/NegativeNumberFormat.html b/website/static/api/enums/NegativeNumberFormat.html new file mode 100644 index 00000000..81408890 --- /dev/null +++ b/website/static/api/enums/NegativeNumberFormat.html @@ -0,0 +1,31 @@ +NegativeNumberFormat | Tableau Extensions API
                                                    Tableau Extensions API
                                                      Preparing search index...

                                                      Enumeration NegativeNumberFormat

                                                      Index

                                                      Enumeration Members

                                                      Automatic +InnerPrefix +InnerSuffix +OuterPrefix +OuterSuffix +Parentheses +

                                                      Enumeration Members

                                                      Automatic: "automatic"
                                                      InnerPrefix: "inner-prefix"
                                                      InnerSuffix: "inner-suffix"
                                                      OuterPrefix: "outer-prefix"
                                                      OuterSuffix: "outer-suffix"
                                                      Parentheses: "parentheses"

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Enumeration Members
                                                      diff --git a/website/static/api/enums/NumberFormatUnits.html b/website/static/api/enums/NumberFormatUnits.html new file mode 100644 index 00000000..80aebeb8 --- /dev/null +++ b/website/static/api/enums/NumberFormatUnits.html @@ -0,0 +1,30 @@ +NumberFormatUnits | Tableau Extensions API
                                                      Tableau Extensions API
                                                        Preparing search index...

                                                        Enumeration NumberFormatUnits

                                                        Index

                                                        Enumeration Members

                                                        BillionsEnglish +BillionsStandard +Millions +None +Thousands +

                                                        Enumeration Members

                                                        BillionsEnglish: "units-billions-english"
                                                        BillionsStandard: "units-billions-standard"
                                                        Millions: "units-millions"
                                                        None: "units-none"
                                                        Thousands: "units-thousands"

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Enumeration Members
                                                        diff --git a/website/static/api/enums/ParameterValueType.html b/website/static/api/enums/ParameterValueType.html new file mode 100644 index 00000000..a7479ea8 --- /dev/null +++ b/website/static/api/enums/ParameterValueType.html @@ -0,0 +1,30 @@ +ParameterValueType | Tableau Extensions API
                                                        Tableau Extensions API
                                                          Preparing search index...

                                                          Enumeration ParameterValueType

                                                          An enumeration describing the different types of allowable values. +This is used for restricting the domain of a parameter

                                                          +
                                                          Index

                                                          Enumeration Members

                                                          All +List +Range +

                                                          Enumeration Members

                                                          All: "all"
                                                          List: "list"
                                                          Range: "range"

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Enumeration Members
                                                          diff --git a/website/static/api/enums/PeriodType.html b/website/static/api/enums/PeriodType.html new file mode 100644 index 00000000..9412c1d8 --- /dev/null +++ b/website/static/api/enums/PeriodType.html @@ -0,0 +1,37 @@ +PeriodType | Tableau Extensions API
                                                          Tableau Extensions API
                                                            Preparing search index...

                                                            Enumeration PeriodType

                                                            Date period used in filters and in parameters.

                                                            +
                                                            Index

                                                            Enumeration Members

                                                            Days +Hours +IsoQuarters +IsoWeeks +IsoYears +Minutes +Months +Quarters +Seconds +Weeks +Years +

                                                            Enumeration Members

                                                            Days: "days"
                                                            Hours: "hours"
                                                            IsoQuarters: "iso-quarters"
                                                            IsoWeeks: "iso-weeks"
                                                            IsoYears: "iso-years"
                                                            Minutes: "minutes"
                                                            Months: "months"
                                                            Quarters: "quarters"
                                                            Seconds: "seconds"
                                                            Weeks: "weeks"
                                                            Years: "years"

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Enumeration Members
                                                            diff --git a/website/static/api/enums/QuickTableCalcType.html b/website/static/api/enums/QuickTableCalcType.html new file mode 100644 index 00000000..a00f84cb --- /dev/null +++ b/website/static/api/enums/QuickTableCalcType.html @@ -0,0 +1,37 @@ +QuickTableCalcType | Tableau Extensions API
                                                            Tableau Extensions API
                                                              Preparing search index...

                                                              Enumeration QuickTableCalcType

                                                              Index

                                                              Enumeration Members

                                                              CompoundGrowthRate +Difference +MovingAverage +PercentDifference +Percentile +PercentOfTotal +Rank +RunningTotal +Undefined +YearOverYearGrowth +YTDGrowth +YTDTotal +

                                                              Enumeration Members

                                                              CompoundGrowthRate: "compound-growth-rate"
                                                              Difference: "difference"
                                                              MovingAverage: "moving-average"
                                                              PercentDifference: "percent-difference"
                                                              Percentile: "percentile"
                                                              PercentOfTotal: "percent-of-total"
                                                              Rank: "rank"
                                                              RunningTotal: "running-total"
                                                              Undefined: "undefined"
                                                              YearOverYearGrowth: "year-over-year-growth"
                                                              YTDGrowth: "ytd-growth"
                                                              YTDTotal: "ytd-total"

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Enumeration Members
                                                              diff --git a/website/static/api/enums/ReplaySpeedType.html b/website/static/api/enums/ReplaySpeedType.html new file mode 100644 index 00000000..77245e19 --- /dev/null +++ b/website/static/api/enums/ReplaySpeedType.html @@ -0,0 +1,33 @@ +ReplaySpeedType | Tableau Extensions API
                                                              Tableau Extensions API
                                                                Preparing search index...

                                                                Enumeration ReplaySpeedType

                                                                Enum that represents the replay speed of an animation.

                                                                +

                                                                1.7.0

                                                                +
                                                                Index

                                                                Enumeration Members

                                                                Fast +Normal +Slow +

                                                                Enumeration Members

                                                                Fast: "fast"

                                                                Used for setting the replay speed of an animation to 2.0x.

                                                                +
                                                                Normal: "normal"

                                                                Used for setting the replay speed of an animation to 1.0x.

                                                                +
                                                                Slow: "slow"

                                                                Used for setting the replay speed of an animation to 0.5x.

                                                                +

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Enumeration Members
                                                                diff --git a/website/static/api/enums/SelectOptions.html b/website/static/api/enums/SelectOptions.html new file mode 100644 index 00000000..04ccd572 --- /dev/null +++ b/website/static/api/enums/SelectOptions.html @@ -0,0 +1,30 @@ +SelectOptions | Tableau Extensions API
                                                                Tableau Extensions API
                                                                  Preparing search index...

                                                                  Enumeration SelectOptions

                                                                  Enum for specifying the select option for the extensions.Worksheet.selectTuplesAsync method.

                                                                  +
                                                                  Index

                                                                  Enumeration Members

                                                                  Simple +Toggle +

                                                                  Enumeration Members

                                                                  Simple: "select-options-simple"

                                                                  Clears existing selection before selecting the tuples specified

                                                                  +
                                                                  Toggle: "select-options-toggle"

                                                                  Adds specified tuples to the existing selection

                                                                  +

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Enumeration Members
                                                                  diff --git a/website/static/api/enums/SelectionUpdateType.html b/website/static/api/enums/SelectionUpdateType.html new file mode 100644 index 00000000..f9dacea1 --- /dev/null +++ b/website/static/api/enums/SelectionUpdateType.html @@ -0,0 +1,29 @@ +SelectionUpdateType | Tableau Extensions API
                                                                  Tableau Extensions API
                                                                    Preparing search index...

                                                                    Enumeration SelectionUpdateType

                                                                    Enum for specifying the selection type for select marks api.

                                                                    +
                                                                    Index

                                                                    Enumeration Members

                                                                    Add +Remove +Replace +

                                                                    Enumeration Members

                                                                    Add: "select-add"
                                                                    Remove: "select-remove"
                                                                    Replace: "select-replace"

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Enumeration Members
                                                                    diff --git a/website/static/api/enums/SheetType.html b/website/static/api/enums/SheetType.html new file mode 100644 index 00000000..3a33e25f --- /dev/null +++ b/website/static/api/enums/SheetType.html @@ -0,0 +1,29 @@ +SheetType | Tableau Extensions API
                                                                    Tableau Extensions API
                                                                      Preparing search index...

                                                                      Enumeration SheetType

                                                                      The type of sheet a [[Sheet]] object represents

                                                                      +
                                                                      Index

                                                                      Enumeration Members

                                                                      Dashboard +Story +Worksheet +

                                                                      Enumeration Members

                                                                      Dashboard: "dashboard"

                                                                      Story

                                                                      Story: "story"
                                                                      Worksheet: "worksheet"

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Enumeration Members
                                                                      diff --git a/website/static/api/enums/SortDirection.html b/website/static/api/enums/SortDirection.html new file mode 100644 index 00000000..7dae2bd7 --- /dev/null +++ b/website/static/api/enums/SortDirection.html @@ -0,0 +1,27 @@ +SortDirection | Tableau Extensions API
                                                                      Tableau Extensions API
                                                                        Preparing search index...

                                                                        Enumeration SortDirection

                                                                        Index

                                                                        Enumeration Members

                                                                        Decreasing +Increasing +

                                                                        Enumeration Members

                                                                        Decreasing: "decreasing"
                                                                        Increasing: "increasing"

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Enumeration Members
                                                                        diff --git a/website/static/api/enums/TableauEventType.html b/website/static/api/enums/TableauEventType.html new file mode 100644 index 00000000..0211ada1 --- /dev/null +++ b/website/static/api/enums/TableauEventType.html @@ -0,0 +1,46 @@ +TableauEventType | Tableau Extensions API
                                                                        Tableau Extensions API
                                                                          Preparing search index...

                                                                          Enumeration TableauEventType

                                                                          Represents the type of event that can be listened for.

                                                                          +
                                                                          Index

                                                                          Enumeration Members - All Extensions

                                                                          DialogMessageReceived +FilterChanged +MarkSelectionChanged +ParameterChanged +SettingsChanged +SummaryDataChanged +

                                                                          Enumeration Members - Dashboard Extensions

                                                                          DashboardLayoutChanged +WorkbookFormattingChanged +

                                                                          Enumeration Members - Viz Extensions

                                                                          WorksheetFormattingChanged +

                                                                          Enumeration Members - All Extensions

                                                                          DialogMessageReceived: "dialog-message-received"

                                                                          Raised when a message is received that was sent by a dialog or extension via sendDialogMessageAsync.

                                                                          +
                                                                          FilterChanged: "filter-changed"

                                                                          Raised when any filter has changed state. You can use this event type with Worksheet objects.

                                                                          +
                                                                          MarkSelectionChanged: "mark-selection-changed"

                                                                          The selected marks on a visualization has changed. +You can use this event type with Worksheet objects.

                                                                          +
                                                                          ParameterChanged: "parameter-changed"

                                                                          A parameter has had its value modified. You can use this event type with Parameter objects.

                                                                          +
                                                                          SettingsChanged: "settings-changed"

                                                                          Settings have been changed for this extension. You can use this event type with Settings objects.

                                                                          +
                                                                          SummaryDataChanged: "summary-data-changed"

                                                                          The summary data backing a worksheet has changed +You can use this event type with Worksheet objects.

                                                                          +

                                                                          Enumeration Members - Dashboard Extensions

                                                                          DashboardLayoutChanged: "dashboard-layout-changed"

                                                                          The dashboard layout has changed

                                                                          +
                                                                          WorkbookFormattingChanged: "workbook-formatting-changed"

                                                                          The workbook formatting has changed

                                                                          +

                                                                          Enumeration Members - Viz Extensions

                                                                          WorksheetFormattingChanged: "worksheet-formatting-changed"

                                                                          The worksheet formatting has changed

                                                                          +

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Enumeration Members - All Extensions
                                                                          Enumeration Members - Dashboard Extensions
                                                                          Enumeration Members - Viz Extensions
                                                                          diff --git a/website/static/api/enums/TrendLineModelType.html b/website/static/api/enums/TrendLineModelType.html new file mode 100644 index 00000000..cdd1808a --- /dev/null +++ b/website/static/api/enums/TrendLineModelType.html @@ -0,0 +1,29 @@ +TrendLineModelType | Tableau Extensions API
                                                                          Tableau Extensions API
                                                                            Preparing search index...

                                                                            Enumeration TrendLineModelType

                                                                            Index

                                                                            Enumeration Members

                                                                            Exponential +Linear +Logarithmic +Polynomial +

                                                                            Enumeration Members

                                                                            Exponential: "exponential"
                                                                            Linear: "linear"
                                                                            Logarithmic: "logarithmic"
                                                                            Polynomial: "polynomial"

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Enumeration Members
                                                                            diff --git a/website/static/api/enums/VizImageEncodingType.html b/website/static/api/enums/VizImageEncodingType.html new file mode 100644 index 00000000..3202fcbf --- /dev/null +++ b/website/static/api/enums/VizImageEncodingType.html @@ -0,0 +1,29 @@ +VizImageEncodingType | Tableau Extensions API
                                                                            Tableau Extensions API
                                                                              Preparing search index...

                                                                              Enumeration VizImageEncodingType

                                                                              Enum that represents the data type of encodings for createVizImageAsync.

                                                                              +

                                                                              1.6.0

                                                                              +
                                                                              Index

                                                                              Enumeration Members

                                                                              Continuous +Discrete +

                                                                              Enumeration Members

                                                                              Continuous: "continuous"
                                                                              Discrete: "discrete"

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Enumeration Members
                                                                              diff --git a/website/static/api/enums/VizImagePaletteType.html b/website/static/api/enums/VizImagePaletteType.html new file mode 100644 index 00000000..8f917ad5 --- /dev/null +++ b/website/static/api/enums/VizImagePaletteType.html @@ -0,0 +1,29 @@ +VizImagePaletteType | Tableau Extensions API
                                                                              Tableau Extensions API
                                                                                Preparing search index...

                                                                                Enumeration VizImagePaletteType

                                                                                Enum that represents the palette type for createVizImageAsync.

                                                                                +

                                                                                1.8.0 and Tableau 2021.4

                                                                                +
                                                                                Index

                                                                                Enumeration Members

                                                                                CustomDiverging +CustomSequential +

                                                                                Enumeration Members

                                                                                CustomDiverging: "custom-diverging"
                                                                                CustomSequential: "custom-sequential"

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Enumeration Members
                                                                                diff --git a/website/static/api/enums/VizImageSizeSettingAlignmentType.html b/website/static/api/enums/VizImageSizeSettingAlignmentType.html new file mode 100644 index 00000000..66347fa3 --- /dev/null +++ b/website/static/api/enums/VizImageSizeSettingAlignmentType.html @@ -0,0 +1,30 @@ +VizImageSizeSettingAlignmentType | Tableau Extensions API
                                                                                Tableau Extensions API
                                                                                  Preparing search index...

                                                                                  Enumeration VizImageSizeSettingAlignmentType

                                                                                  Enum that represents the Size Setting alignment type for createVizImageAsync.

                                                                                  +

                                                                                  1.8.0 and Tableau 2021.4

                                                                                  +
                                                                                  Index

                                                                                  Enumeration Members

                                                                                  Center +Left +Right +

                                                                                  Enumeration Members

                                                                                  Center: "center"
                                                                                  Left: "left"
                                                                                  Right: "right"

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Enumeration Members
                                                                                  diff --git a/website/static/api/enums/VizImageSizeSettingType.html b/website/static/api/enums/VizImageSizeSettingType.html new file mode 100644 index 00000000..93abc66a --- /dev/null +++ b/website/static/api/enums/VizImageSizeSettingType.html @@ -0,0 +1,29 @@ +VizImageSizeSettingType | Tableau Extensions API
                                                                                  Tableau Extensions API
                                                                                    Preparing search index...

                                                                                    Enumeration VizImageSizeSettingType

                                                                                    Enum that represents the Size Setting type for createVizImageAsync.

                                                                                    +

                                                                                    1.8.0 and Tableau 2021.4

                                                                                    +
                                                                                    Index

                                                                                    Enumeration Members

                                                                                    Fixed +Manual +

                                                                                    Enumeration Members

                                                                                    Fixed: "fixed"
                                                                                    Manual: "manual"

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Enumeration Members
                                                                                    diff --git a/website/static/api/enums/VizImageSortDirectionType.html b/website/static/api/enums/VizImageSortDirectionType.html new file mode 100644 index 00000000..c0f37fac --- /dev/null +++ b/website/static/api/enums/VizImageSortDirectionType.html @@ -0,0 +1,29 @@ +VizImageSortDirectionType | Tableau Extensions API
                                                                                    Tableau Extensions API
                                                                                      Preparing search index...

                                                                                      Enumeration VizImageSortDirectionType

                                                                                      Enum that represents the sort direction for createVizImageAsync.

                                                                                      +

                                                                                      1.8.0 and Tableau 2021.4

                                                                                      +
                                                                                      Index

                                                                                      Enumeration Members

                                                                                      Ascending +Descending +

                                                                                      Enumeration Members

                                                                                      Ascending: "ascending"
                                                                                      Descending: "descending"

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Enumeration Members
                                                                                      diff --git a/website/static/api/enums/sharederrorcodes.html b/website/static/api/enums/sharederrorcodes.html index 786a3c8c..a632b7e8 100644 --- a/website/static/api/enums/sharederrorcodes.html +++ b/website/static/api/enums/sharederrorcodes.html @@ -1,523 +1,62 @@ - - - - - - SharedErrorCodes | Tableau Extensions - - - - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -
                                                                                      -
                                                                                      - Options -
                                                                                      -
                                                                                      - All -
                                                                                        -
                                                                                      • Public
                                                                                        • -
                                                                                      • Public/Protected
                                                                                        • -
                                                                                      • All
                                                                                        • -
                                                                                      -
                                                                                      - - - - -
                                                                                      -
                                                                                      - Menu -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      Enumeration SharedErrorCodes

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Index

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Enumeration members

                                                                                      - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Enumeration members

                                                                                      -
                                                                                      - -

                                                                                      ApiExecutionError

                                                                                      -
                                                                                      ApiExecutionError: = "api-execution-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      Can occur when two incompatible calls are triggered together.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      CrosstabCreationError

                                                                                      -
                                                                                      CrosstabCreationError: = "crosstab-creation-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A CSV or Excel file failed to be created in Viz.exportCrosstabAsync().

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      DataCreationError

                                                                                      -
                                                                                      DataCreationError: = "data-creation-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A CSV file failed to be created in Viz.exportDataAsync().

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      ImplementationError

                                                                                      -
                                                                                      ImplementationError: = "wrong-implementation"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      Property or Function is not supported within the Tableau API.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InternalError

                                                                                      -
                                                                                      InternalError: = "internal-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      An error occurred within the Tableau API. Contact Tableau Support.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidAggregationFieldName

                                                                                      -
                                                                                      InvalidAggregationFieldName: = "invalid-aggregation-field-name"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      An invalid aggregation was specified for the filter, such as setting a range filter to "SUM(Sales)" instead of - "Sales".

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidFilterFieldName

                                                                                      -
                                                                                      InvalidFilterFieldName: = "invalid-filter-name"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A filter operation was attempted on a field that does not exist in the data source.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidFilterFieldValue

                                                                                      -
                                                                                      InvalidFilterFieldValue: = "invalid-filter-fieldValue"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A filter operation was attempted using a value that is the wrong data type or format.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidParameter

                                                                                      -
                                                                                      InvalidParameter: = "invalid-parameter"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidSelectionDate

                                                                                      -
                                                                                      InvalidSelectionDate: = "invalid-selection-date"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidSelectionFieldName

                                                                                      -
                                                                                      InvalidSelectionFieldName: = "invalid-selection-fieldName"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidSelectionSheet

                                                                                      -
                                                                                      InvalidSelectionSheet: = "invalid-selection-sheet"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A parameter did not include a valid sheet selection for exporting.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      InvalidSelectionValue

                                                                                      -
                                                                                      InvalidSelectionValue: = "invalid-selection-value"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      An invalid value was specified in a Sheet.selectMarksAsync() call.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      NotActiveSheet

                                                                                      -
                                                                                      NotActiveSheet: = "not-active-sheet"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      An operation was attempted on a sheet that is not active or embedded within the active dashboard.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      PDFCreationError

                                                                                      -
                                                                                      PDFCreationError: = "pdf-creation-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A PDF file failed to be created in Viz.exportPDFAsync().

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      PowerPointCreationError

                                                                                      -
                                                                                      PowerPointCreationError: = "powerpoint-creation-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A PowerPoint file failed to be created in Viz.exportPowerPointAsync().

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      ServerError

                                                                                      -
                                                                                      ServerError: = "server-error"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      A general-purpose server error occurred. Details are contained in the Error object.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      Timeout

                                                                                      -
                                                                                      Timeout: = "timeout"
                                                                                      - -
                                                                                      -
                                                                                      -

                                                                                      Can occur when an api call times out.

                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Legend

                                                                                      -
                                                                                      -
                                                                                        -
                                                                                      • Module
                                                                                        • -
                                                                                      • Object literal
                                                                                        • -
                                                                                      • Variable
                                                                                        • -
                                                                                      • Function
                                                                                        • -
                                                                                      • Function with type parameter
                                                                                        • -
                                                                                      • Index signature
                                                                                        • -
                                                                                      • Type alias
                                                                                        • -
                                                                                      • Type alias with type parameter
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Enumeration
                                                                                        • -
                                                                                      • Enumeration member
                                                                                        • -
                                                                                      • Property
                                                                                        • -
                                                                                      • Method
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Interface
                                                                                        • -
                                                                                      • Interface with type parameter
                                                                                        • -
                                                                                      • Constructor
                                                                                        • -
                                                                                      • Property
                                                                                        • -
                                                                                      • Method
                                                                                        • -
                                                                                      • Index signature
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Class
                                                                                        • -
                                                                                      • Class with type parameter
                                                                                        • -
                                                                                      • Constructor
                                                                                        • -
                                                                                      • Property
                                                                                        • -
                                                                                      • Method
                                                                                        • -
                                                                                      • Accessor
                                                                                        • -
                                                                                      • Index signature
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Inherited constructor
                                                                                        • -
                                                                                      • Inherited property
                                                                                        • -
                                                                                      • Inherited method
                                                                                        • -
                                                                                      • Inherited accessor
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Protected property
                                                                                        • -
                                                                                      • Protected method
                                                                                        • -
                                                                                      • Protected accessor
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Private property
                                                                                        • -
                                                                                      • Private method
                                                                                        • -
                                                                                      • Private accessor
                                                                                        • -
                                                                                      -
                                                                                        -
                                                                                      • Static property
                                                                                        • -
                                                                                      • Static method
                                                                                        • -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - - - - \ No newline at end of file +SharedErrorCodes | Tableau Extensions API
                                                                                      Tableau Extensions API
                                                                                        Preparing search index...

                                                                                        Enumeration SharedErrorCodes

                                                                                        Index

                                                                                        Enumeration Members

                                                                                        ApiExecutionError +CrosstabCreationError +DataCreationError +ImplementationError +InternalError +InvalidAggregationFieldName +InvalidFilterFieldName +InvalidFilterFieldValue +InvalidParameter +InvalidSelectionDate +InvalidSelectionFieldName +InvalidSelectionSheet +InvalidSelectionValue +NotActiveSheet +PDFCreationError +PowerPointCreationError +ServerError +Timeout +

                                                                                        Enumeration Members

                                                                                        ApiExecutionError: "api-execution-error"

                                                                                        Can occur when two incompatible calls are triggered together.

                                                                                        +
                                                                                        CrosstabCreationError: "crosstab-creation-error"

                                                                                        A CSV or Excel file failed to be created in Viz.exportCrosstabAsync().

                                                                                        +
                                                                                        DataCreationError: "data-creation-error"

                                                                                        A CSV file failed to be created in Viz.exportDataAsync().

                                                                                        +
                                                                                        ImplementationError: "wrong-implementation"

                                                                                        Property or Function is not supported within the Tableau API.

                                                                                        +
                                                                                        InternalError: "internal-error"

                                                                                        An error occurred within the Tableau API. Contact Tableau Support.

                                                                                        +
                                                                                        InvalidAggregationFieldName: "invalid-aggregation-field-name"

                                                                                        An invalid aggregation was specified for the filter, such as setting a range filter to "SUM(Sales)" instead of +"Sales".

                                                                                        +
                                                                                        InvalidFilterFieldName: "invalid-filter-name"

                                                                                        A filter operation was attempted on a field that does not exist in the data source.

                                                                                        +
                                                                                        InvalidFilterFieldValue: "invalid-filter-fieldValue"

                                                                                        A filter operation was attempted using a value that is the wrong data type or format.

                                                                                        +
                                                                                        InvalidParameter: "invalid-parameter"

                                                                                        A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.

                                                                                        +
                                                                                        InvalidSelectionDate: "invalid-selection-date"

                                                                                        An invalid date value was specified in a Sheet.selectMarksAsync() call for a date field.

                                                                                        +
                                                                                        InvalidSelectionFieldName: "invalid-selection-fieldName"

                                                                                        A field was specified in a Sheet.selectMarksAsync() call that does not exist in the data source.

                                                                                        +
                                                                                        InvalidSelectionSheet: "invalid-selection-sheet"

                                                                                        A parameter did not include a valid sheet selection for exporting.

                                                                                        +
                                                                                        InvalidSelectionValue: "invalid-selection-value"

                                                                                        An invalid value was specified in a Sheet.selectMarksAsync() call.

                                                                                        +
                                                                                        NotActiveSheet: "not-active-sheet"

                                                                                        An operation was attempted on a sheet that is not active or embedded within the active dashboard.

                                                                                        +
                                                                                        PDFCreationError: "pdf-creation-error"

                                                                                        A PDF file failed to be created in Viz.exportPDFAsync().

                                                                                        +
                                                                                        PowerPointCreationError: "powerpoint-creation-error"

                                                                                        A PowerPoint file failed to be created in Viz.exportPowerPointAsync().

                                                                                        +
                                                                                        ServerError: "server-error"

                                                                                        A general-purpose server error occurred. Details are contained in the Error object.

                                                                                        +
                                                                                        Timeout: "timeout"

                                                                                        Can occur when an api call times out.

                                                                                        +

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Enumeration Members
                                                                                        diff --git a/website/static/api/enums/tableau.analyticsobjecttype.html b/website/static/api/enums/tableau.analyticsobjecttype.html deleted file mode 100644 index c1c2f78b..00000000 --- a/website/static/api/enums/tableau.analyticsobjecttype.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - AnalyticsObjectType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration AnalyticsObjectType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Cluster

                                                                                        -
                                                                                        Cluster: = "cluster"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Forecast

                                                                                        -
                                                                                        Forecast: = "forecast"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TrendLine

                                                                                        -
                                                                                        TrendLine: = "trend-line"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.annotationtype.html b/website/static/api/enums/tableau.annotationtype.html deleted file mode 100644 index 92f78b15..00000000 --- a/website/static/api/enums/tableau.annotationtype.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - AnnotationType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration AnnotationType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Area

                                                                                        -
                                                                                        Area: = "area"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Mark

                                                                                        -
                                                                                        Mark: = "mark"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Point

                                                                                        -
                                                                                        Point: = "point"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.classnamekey.html b/website/static/api/enums/tableau.classnamekey.html deleted file mode 100644 index 74d45799..00000000 --- a/website/static/api/enums/tableau.classnamekey.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - ClassNameKey | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ClassNameKey

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        ColumnDividers

                                                                                        -
                                                                                        ColumnDividers: = "tableau-column-dividers"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        DashboardTitle

                                                                                        -
                                                                                        DashboardTitle: = "tableau-dashboard-title"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Pane

                                                                                        -
                                                                                        Pane: = "tableau-pane"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        RowDividers

                                                                                        -
                                                                                        RowDividers: = "tableau-row-dividers"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        StoryTitle

                                                                                        -
                                                                                        StoryTitle: = "tableau-story-title"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Tooltip

                                                                                        -
                                                                                        Tooltip: = "tableau-tooltip"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Worksheet

                                                                                        -
                                                                                        Worksheet: = "tableau-worksheet"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        WorksheetTitle

                                                                                        -
                                                                                        WorksheetTitle: = "tableau-worksheet-title"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.columntype.html b/website/static/api/enums/tableau.columntype.html deleted file mode 100644 index ca6fc98a..00000000 --- a/website/static/api/enums/tableau.columntype.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - ColumnType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ColumnType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Continuous

                                                                                        -
                                                                                        Continuous: = "continuous"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Discrete

                                                                                        -
                                                                                        Discrete: = "discrete"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Unknown

                                                                                        -
                                                                                        Unknown: = "unknown"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.dashboardlayoutchange.html b/website/static/api/enums/tableau.dashboardlayoutchange.html deleted file mode 100644 index 23564e65..00000000 --- a/website/static/api/enums/tableau.dashboardlayoutchange.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - - DashboardLayoutChange | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DashboardLayoutChange

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the changes that occur to a dashboard object.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Added

                                                                                        -
                                                                                        Added: = "added"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object was added

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        DashboardChanged

                                                                                        -
                                                                                        DashboardChanged: = "dashboard-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Navigate to another dashboard

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Deselected

                                                                                        -
                                                                                        Deselected: = "deselected"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object is deselected

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        IsFloatingChanged

                                                                                        -
                                                                                        IsFloatingChanged: = "is-floating-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object's floating state changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        IsVisibleChanged

                                                                                        -
                                                                                        IsVisibleChanged: = "is-visible-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object's visibility changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        NameChanged

                                                                                        -
                                                                                        NameChanged: = "name-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object was renamed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        PositionChanged

                                                                                        -
                                                                                        PositionChanged: = "position-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object's position changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Removed

                                                                                        -
                                                                                        Removed: = "removed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object was removed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Selected

                                                                                        -
                                                                                        Selected: = "selected"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object is selected

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        SizeChanged

                                                                                        -
                                                                                        SizeChanged: = "size-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dashboard object's size changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.dashboardobjecttype.html b/website/static/api/enums/tableau.dashboardobjecttype.html deleted file mode 100644 index 3cec4131..00000000 --- a/website/static/api/enums/tableau.dashboardobjecttype.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - DashboardObjectType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DashboardObjectType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        What the object represents in a dashboard.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Blank

                                                                                        -
                                                                                        Blank: = "blank"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Extension

                                                                                        -
                                                                                        Extension: = "extension"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Image

                                                                                        -
                                                                                        Image: = "image"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Legend

                                                                                        -
                                                                                        Legend: = "legend"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        PageFilter

                                                                                        -
                                                                                        PageFilter: = "page-filter"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        ParameterControl

                                                                                        -
                                                                                        ParameterControl: = "parameter-control"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        QuickFilter

                                                                                        -
                                                                                        QuickFilter: = "quick-filter"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Text

                                                                                        -
                                                                                        Text: = "text"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Title

                                                                                        -
                                                                                        Title: = "title"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        WebPage

                                                                                        -
                                                                                        WebPage: = "web-page"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Worksheet

                                                                                        -
                                                                                        Worksheet: = "worksheet"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html b/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html deleted file mode 100644 index 88a24760..00000000 --- a/website/static/api/enums/tableau.dashboardobjectvisibilitytype.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - DashboardObjectVisibilityType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DashboardObjectVisibilityType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the visibility state of a dashboard object.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.7.0

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Hide

                                                                                        -
                                                                                        Hide: = "hide"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Used for turning off the visibility of a dashboard object.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Show

                                                                                        -
                                                                                        Show: = "show"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Used for turning on the visibility of a dashboard object.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.datatype.html b/website/static/api/enums/tableau.datatype.html deleted file mode 100644 index 2357c756..00000000 --- a/website/static/api/enums/tableau.datatype.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - DataType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DataType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The different types of data a value can have

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Bool

                                                                                        -
                                                                                        Bool: = "bool"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Date

                                                                                        -
                                                                                        Date: = "date"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        DateTime

                                                                                        -
                                                                                        DateTime: = "date-time"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Float

                                                                                        -
                                                                                        Float: = "float"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Int

                                                                                        -
                                                                                        Int: = "int"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Spatial

                                                                                        -
                                                                                        Spatial: = "spatial"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        String

                                                                                        -
                                                                                        String: = "string"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Unknown

                                                                                        -
                                                                                        Unknown: = "unknown"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.daterangetype.html b/website/static/api/enums/tableau.daterangetype.html deleted file mode 100644 index f791bb11..00000000 --- a/website/static/api/enums/tableau.daterangetype.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - DateRangeType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DateRangeType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Valid date ranges for a relative date filter.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Current

                                                                                        -
                                                                                        Current: = "current"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Last

                                                                                        -
                                                                                        Last: = "last"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        LastN

                                                                                        -
                                                                                        LastN: = "last-n"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Next

                                                                                        -
                                                                                        Next: = "next"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        NextN

                                                                                        -
                                                                                        NextN: = "next-n"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        ToDate

                                                                                        -
                                                                                        ToDate: = "to-date"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.dialogstyle.html b/website/static/api/enums/tableau.dialogstyle.html deleted file mode 100644 index e4d55c61..00000000 --- a/website/static/api/enums/tableau.dialogstyle.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - DialogStyle | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration DialogStyle

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the types of dialog popup styles.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Modal

                                                                                        -
                                                                                        Modal: = "modal"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Modeless

                                                                                        -
                                                                                        Modeless: = "modeless"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Window

                                                                                        -
                                                                                        Window: = "window"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.encodingtype.html b/website/static/api/enums/tableau.encodingtype.html deleted file mode 100644 index 93ba3dbf..00000000 --- a/website/static/api/enums/tableau.encodingtype.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - EncodingType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration EncodingType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Angle

                                                                                        -
                                                                                        Angle: = "angle"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Color

                                                                                        -
                                                                                        Color: = "color"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Column

                                                                                        -
                                                                                        Column: = "column"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Custom

                                                                                        -
                                                                                        Custom: = "custom"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Detail

                                                                                        -
                                                                                        Detail: = "detail"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Filter

                                                                                        -
                                                                                        Filter: = "filter"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Geometry

                                                                                        -
                                                                                        Geometry: = "geometry"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Label

                                                                                        -
                                                                                        Label: = "label"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        MarksType

                                                                                        -
                                                                                        MarksType: = "marks-type"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        MeasureValues

                                                                                        -
                                                                                        MeasureValues: = "measure-values"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Page

                                                                                        -
                                                                                        Page: = "page"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Path

                                                                                        -
                                                                                        Path: = "path"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Row

                                                                                        -
                                                                                        Row: = "row"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Shape

                                                                                        -
                                                                                        Shape: = "shape"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Size

                                                                                        -
                                                                                        Size: = "size"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Tooltip

                                                                                        -
                                                                                        Tooltip: = "tooltip"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.errorcodes.html b/website/static/api/enums/tableau.errorcodes.html deleted file mode 100644 index 163ccc79..00000000 --- a/website/static/api/enums/tableau.errorcodes.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - ErrorCodes | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ErrorCodes

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        All error codes used by the Extensions API.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        APINotInitialized

                                                                                        -
                                                                                        APINotInitialized: = "api-not-initialized"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Thrown when caller attempts to execute command before initialization has completed.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        DialogAlreadyOpen

                                                                                        -
                                                                                        DialogAlreadyOpen: = "dialog-already-open"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Only one dialog can be opened at time with the UI namespace functionality.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        DialogClosedByUser

                                                                                        -
                                                                                        DialogClosedByUser: = "dialog-closed-by-user"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The open dialog was closed by the user.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        InternalError

                                                                                        -
                                                                                        InternalError: = "internal-error"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        An error occurred within the Tableau Extensions API. Contact Tableau Support.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        InvalidDomainDialog

                                                                                        -
                                                                                        InvalidDomainDialog: = "invalid-dialog-domain"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A dialog must start on the same domain as the parent extenion.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        InvalidParameter

                                                                                        -
                                                                                        InvalidParameter: = "invalid-parameter"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A parameter is not the correct data type or format. The name of the parameter is specified in the Error.message field.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        MissingFilter

                                                                                        -
                                                                                        MissingFilter: = "missing-filter"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Can occur if the extension interacts with a filter that has been removed from the worksheet.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        MissingParameter

                                                                                        -
                                                                                        MissingParameter: = "missing-parameter"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Can occur if the extension interacts with a parameter that has been removed from the worksheet.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        ServerError

                                                                                        -
                                                                                        ServerError: = "server-error"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Internal Server Error

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        SettingSaveInProgress

                                                                                        -
                                                                                        SettingSaveInProgress: = "setting-save-in-progress"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Developer cannot save settings while another save is still in progress.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        UnsupportedEventName

                                                                                        -
                                                                                        UnsupportedEventName: = "unsupported-event-name"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        An unknown event name was specified in the call to addEventListener or removeEventListener.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        UnsupportedMethodForDataSourceType

                                                                                        -
                                                                                        UnsupportedMethodForDataSourceType: = "unsupported-method-for-data-source-type"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A method was used for a type of data source that doesn't support that method (see getActiveTablesAsync for an example)

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        VisibilityError

                                                                                        -
                                                                                        VisibilityError: = "visibility-error"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Thrown when caller attempts to execute command while extension is not visible.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.extensioncontext.html b/website/static/api/enums/tableau.extensioncontext.html deleted file mode 100644 index c7549640..00000000 --- a/website/static/api/enums/tableau.extensioncontext.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - ExtensionContext | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ExtensionContext

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The context in which the Extensions is currently running.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Cloud

                                                                                        -
                                                                                        Cloud: = "cloud"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Desktop

                                                                                        -
                                                                                        Desktop: = "desktop"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        PublicDesktop

                                                                                        -
                                                                                        PublicDesktop: = "public-desktop"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        PublicWeb

                                                                                        -
                                                                                        PublicWeb: = "public-web"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Server

                                                                                        -
                                                                                        Server: = "server"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.extensionmode.html b/website/static/api/enums/tableau.extensionmode.html deleted file mode 100644 index abecee26..00000000 --- a/website/static/api/enums/tableau.extensionmode.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - ExtensionMode | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ExtensionMode

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The mode in which the Extensions is currently running.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Authoring

                                                                                        -
                                                                                        Authoring: = "authoring"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Viewing

                                                                                        -
                                                                                        Viewing: = "viewing"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.fieldaggregationtype.html b/website/static/api/enums/tableau.fieldaggregationtype.html deleted file mode 100644 index 0fcf19ea..00000000 --- a/website/static/api/enums/tableau.fieldaggregationtype.html +++ /dev/null @@ -1,753 +0,0 @@ - - - - - - FieldAggregationType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FieldAggregationType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Type of aggregation on a field.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Attr

                                                                                        -
                                                                                        Attr: = "attr"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Avg

                                                                                        -
                                                                                        Avg: = "avg"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Collect

                                                                                        -
                                                                                        Collect: = "collect"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Count

                                                                                        -
                                                                                        Count: = "count"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Countd

                                                                                        -
                                                                                        Countd: = "countd"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Day

                                                                                        -
                                                                                        Day: = "day"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        End

                                                                                        -
                                                                                        End: = "end"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Hour

                                                                                        -
                                                                                        Hour: = "hour"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        InOut

                                                                                        -
                                                                                        InOut: = "in-out"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Kurtosis

                                                                                        -
                                                                                        Kurtosis: = "kurtosis"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Max

                                                                                        -
                                                                                        Max: = "max"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Mdy

                                                                                        -
                                                                                        Mdy: = "mdy"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Median

                                                                                        -
                                                                                        Median: = "median"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Min

                                                                                        -
                                                                                        Min: = "min"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Minute

                                                                                        -
                                                                                        Minute: = "minute"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Month

                                                                                        -
                                                                                        Month: = "month"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        MonthYear

                                                                                        -
                                                                                        MonthYear: = "month-year"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        None

                                                                                        -
                                                                                        None: = "none"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Qtr

                                                                                        -
                                                                                        Qtr: = "qtr"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Quart1

                                                                                        -
                                                                                        Quart1: = "quart1"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Quart3

                                                                                        -
                                                                                        Quart3: = "quart3"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Second

                                                                                        -
                                                                                        Second: = "second"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Skewness

                                                                                        -
                                                                                        Skewness: = "skewness"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Stdev

                                                                                        -
                                                                                        Stdev: = "stdev"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Stdevp

                                                                                        -
                                                                                        Stdevp: = "stdevp"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Sum

                                                                                        -
                                                                                        Sum: = "sum"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncDay

                                                                                        -
                                                                                        TruncDay: = "trunc-day"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncHour

                                                                                        -
                                                                                        TruncHour: = "trunc-hour"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncMinute

                                                                                        -
                                                                                        TruncMinute: = "trunc-minute"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncMonth

                                                                                        -
                                                                                        TruncMonth: = "trunc-month"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncQtr

                                                                                        -
                                                                                        TruncQtr: = "trunc-qtr"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncSecond

                                                                                        -
                                                                                        TruncSecond: = "trunc-second"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncWeek

                                                                                        -
                                                                                        TruncWeek: = "trunc-week"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        TruncYear

                                                                                        -
                                                                                        TruncYear: = "trunc-year"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        User

                                                                                        -
                                                                                        User: = "user"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Var

                                                                                        -
                                                                                        Var: = "var"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Varp

                                                                                        -
                                                                                        Varp: = "varp"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Week

                                                                                        -
                                                                                        Week: = "week"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Weekday

                                                                                        -
                                                                                        Weekday: = "weekday"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Year

                                                                                        -
                                                                                        Year: = "year"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.fieldroletype.html b/website/static/api/enums/tableau.fieldroletype.html deleted file mode 100644 index 0d8bfa04..00000000 --- a/website/static/api/enums/tableau.fieldroletype.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - FieldRoleType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FieldRoleType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Role of a field.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Dimension

                                                                                        -
                                                                                        Dimension: = "dimension"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Measure

                                                                                        -
                                                                                        Measure: = "measure"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Unknown

                                                                                        -
                                                                                        Unknown: = "unknown"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.filterdomaintype.html b/website/static/api/enums/tableau.filterdomaintype.html deleted file mode 100644 index ce6fba61..00000000 --- a/website/static/api/enums/tableau.filterdomaintype.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - FilterDomainType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FilterDomainType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The domain type for a filter

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Database

                                                                                        -
                                                                                        Database: = "database"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        list of all possible domain values from database

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Relevant

                                                                                        -
                                                                                        Relevant: = "relevant"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The domain values that are relevant to the specified filter - i.e. the domain is restricted by a previous filter

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.filternulloption.html b/website/static/api/enums/tableau.filternulloption.html deleted file mode 100644 index 45cf332c..00000000 --- a/website/static/api/enums/tableau.filternulloption.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - FilterNullOption | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FilterNullOption

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The option for specifying which values to include for filtering - Indicates what to do with null values for a given filter or mark selection call.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        AllValues

                                                                                        -
                                                                                        AllValues: = "all-values"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        NonNullValues

                                                                                        -
                                                                                        NonNullValues: = "non-null-values"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        NullValues

                                                                                        -
                                                                                        NullValues: = "null-values"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.filtertype.html b/website/static/api/enums/tableau.filtertype.html deleted file mode 100644 index ddc95ab9..00000000 --- a/website/static/api/enums/tableau.filtertype.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - FilterType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FilterType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        An enumeration of the valid types of filters that can be applied.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Categorical

                                                                                        -
                                                                                        Categorical: = "categorical"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Hierarchical

                                                                                        -
                                                                                        Hierarchical: = "hierarchical"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Range

                                                                                        -
                                                                                        Range: = "range"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        RelativeDate

                                                                                        -
                                                                                        RelativeDate: = "relative-date"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.filterupdatetype.html b/website/static/api/enums/tableau.filterupdatetype.html deleted file mode 100644 index ec5d612a..00000000 --- a/website/static/api/enums/tableau.filterupdatetype.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - FilterUpdateType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration FilterUpdateType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The different update types for applying filter

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Add

                                                                                        -
                                                                                        Add: = "add"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        All

                                                                                        -
                                                                                        All: = "all"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Remove

                                                                                        -
                                                                                        Remove: = "remove"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Replace

                                                                                        -
                                                                                        Replace: = "replace"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.hierarchicallevelselectionstate.html b/website/static/api/enums/tableau.hierarchicallevelselectionstate.html deleted file mode 100644 index 9d9b0468..00000000 --- a/website/static/api/enums/tableau.hierarchicallevelselectionstate.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - HierarchicalLevelSelectionState | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration HierarchicalLevelSelectionState

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the selection state of a level in a hierarchical filter

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        Extensions 1.10.0

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        AllSelected

                                                                                        -
                                                                                        AllSelected: = "all-selected"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        NoneSelected

                                                                                        -
                                                                                        NoneSelected: = "none-selected"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        SomeSelected

                                                                                        -
                                                                                        SomeSelected: = "some-selected"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        UnknownSelected

                                                                                        -
                                                                                        UnknownSelected: = "unknown-selected"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.includedatavaluesoption.html b/website/static/api/enums/tableau.includedatavaluesoption.html deleted file mode 100644 index fce45569..00000000 --- a/website/static/api/enums/tableau.includedatavaluesoption.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - IncludeDataValuesOption | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration IncludeDataValuesOption

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that serves as a filter on the DataValues returned from getSummaryDataReaderAsync, - getUnderlyingTableDataReaderAsync and getLogicalTableDataReaderAsync. - This is an optimization of returned data values only. Tableau versions prior to 2021.2 - will pass the data across and populate the DataValue properties. - Please note that all properties not requested will be undefined in the DataValue results.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.5.0

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        AllValues

                                                                                        -
                                                                                        AllValues: = "all-values"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        DataValues will include all properties.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        OnlyFormattedValues

                                                                                        -
                                                                                        OnlyFormattedValues: = "only-formatted-values"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        DataValues will only include formattedValue properties.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        OnlyNativeValues

                                                                                        -
                                                                                        OnlyNativeValues: = "only-native-values"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        DataValues will only include value and nativeValue properties.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.marktype.html b/website/static/api/enums/tableau.marktype.html deleted file mode 100644 index e316ff2f..00000000 --- a/website/static/api/enums/tableau.marktype.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - MarkType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration MarkType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Type of mark for a given marks card in a viz.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Area

                                                                                        -
                                                                                        Area: = "area"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Bar

                                                                                        -
                                                                                        Bar: = "bar"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Circle

                                                                                        -
                                                                                        Circle: = "circle"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        GanttBar

                                                                                        -
                                                                                        GanttBar: = "gantt-bar"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Heatmap

                                                                                        -
                                                                                        Heatmap: = "heatmap"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Line

                                                                                        -
                                                                                        Line: = "line"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Map

                                                                                        -
                                                                                        Map: = "map"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Pie

                                                                                        -
                                                                                        Pie: = "pie"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Polygon

                                                                                        -
                                                                                        Polygon: = "polygon"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Shape

                                                                                        -
                                                                                        Shape: = "shape"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Square

                                                                                        -
                                                                                        Square: = "square"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Text

                                                                                        -
                                                                                        Text: = "text"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        VizExtension

                                                                                        -
                                                                                        VizExtension: = "viz-extension"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.parametervaluetype.html b/website/static/api/enums/tableau.parametervaluetype.html deleted file mode 100644 index d7cc92fa..00000000 --- a/website/static/api/enums/tableau.parametervaluetype.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - ParameterValueType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ParameterValueType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        An enumeration describing the different types of allowable values. - This is used for restricting the domain of a parameter

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        All

                                                                                        -
                                                                                        All: = "all"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        List

                                                                                        -
                                                                                        List: = "list"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Range

                                                                                        -
                                                                                        Range: = "range"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.periodtype.html b/website/static/api/enums/tableau.periodtype.html deleted file mode 100644 index 0c327836..00000000 --- a/website/static/api/enums/tableau.periodtype.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - PeriodType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration PeriodType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Date period used in filters and in parameters.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Days

                                                                                        -
                                                                                        Days: = "days"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Hours

                                                                                        -
                                                                                        Hours: = "hours"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        IsoQuarters

                                                                                        -
                                                                                        IsoQuarters: = "iso-quarters"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        IsoWeeks

                                                                                        -
                                                                                        IsoWeeks: = "iso-weeks"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        IsoYears

                                                                                        -
                                                                                        IsoYears: = "iso-years"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Minutes

                                                                                        -
                                                                                        Minutes: = "minutes"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Months

                                                                                        -
                                                                                        Months: = "months"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Quarters

                                                                                        -
                                                                                        Quarters: = "quarters"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Seconds

                                                                                        -
                                                                                        Seconds: = "seconds"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Weeks

                                                                                        -
                                                                                        Weeks: = "weeks"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Years

                                                                                        -
                                                                                        Years: = "years"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.quicktablecalctype.html b/website/static/api/enums/tableau.quicktablecalctype.html deleted file mode 100644 index 15de213b..00000000 --- a/website/static/api/enums/tableau.quicktablecalctype.html +++ /dev/null @@ -1,354 +0,0 @@ - - - - - - QuickTableCalcType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration QuickTableCalcType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        CompoundGrowthRate

                                                                                        -
                                                                                        CompoundGrowthRate: = "compound-growth-rate"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Difference

                                                                                        -
                                                                                        Difference: = "difference"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        MovingAverage

                                                                                        -
                                                                                        MovingAverage: = "moving-average"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        PercentDifference

                                                                                        -
                                                                                        PercentDifference: = "percent-difference"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        PercentOfTotal

                                                                                        -
                                                                                        PercentOfTotal: = "percent-of-total"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Percentile

                                                                                        -
                                                                                        Percentile: = "percentile"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Rank

                                                                                        -
                                                                                        Rank: = "rank"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        RunningTotal

                                                                                        -
                                                                                        RunningTotal: = "running-total"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Undefined

                                                                                        -
                                                                                        Undefined: = "undefined"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        YTDGrowth

                                                                                        -
                                                                                        YTDGrowth: = "ytd-growth"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        YTDTotal

                                                                                        -
                                                                                        YTDTotal: = "ytd-total"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        YearOverYearGrowth

                                                                                        -
                                                                                        YearOverYearGrowth: = "year-over-year-growth"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.replayspeedtype.html b/website/static/api/enums/tableau.replayspeedtype.html deleted file mode 100644 index e8520c7d..00000000 --- a/website/static/api/enums/tableau.replayspeedtype.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - ReplaySpeedType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration ReplaySpeedType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the replay speed of an animation.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.7.0

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Fast

                                                                                        -
                                                                                        Fast: = "fast"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Used for setting the replay speed of an animation to 2.0x.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Normal

                                                                                        -
                                                                                        Normal: = "normal"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Used for setting the replay speed of an animation to 1.0x.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Slow

                                                                                        -
                                                                                        Slow: = "slow"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Used for setting the replay speed of an animation to 0.5x.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.selectionupdatetype.html b/website/static/api/enums/tableau.selectionupdatetype.html deleted file mode 100644 index 006866cc..00000000 --- a/website/static/api/enums/tableau.selectionupdatetype.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - SelectionUpdateType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration SelectionUpdateType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum for specifying the selection type for select marks api.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Add

                                                                                        -
                                                                                        Add: = "select-add"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Remove

                                                                                        -
                                                                                        Remove: = "select-remove"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Replace

                                                                                        -
                                                                                        Replace: = "select-replace"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.selectoptions.html b/website/static/api/enums/tableau.selectoptions.html deleted file mode 100644 index 4745fa0b..00000000 --- a/website/static/api/enums/tableau.selectoptions.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - SelectOptions | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration SelectOptions

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum for specifying the select option for the extensions.Worksheet.selectTuplesAsync method.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Simple

                                                                                        -
                                                                                        Simple: = "select-options-simple"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Clears existing selection before selecting the tuples specified

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Toggle

                                                                                        -
                                                                                        Toggle: = "select-options-toggle"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Adds specified tuples to the existing selection

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.sheettype.html b/website/static/api/enums/tableau.sheettype.html deleted file mode 100644 index a87088b7..00000000 --- a/website/static/api/enums/tableau.sheettype.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - SheetType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration SheetType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        The type of sheet a Sheet object represents

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Dashboard

                                                                                        -
                                                                                        Dashboard: = "dashboard"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Story

                                                                                        -
                                                                                        Story: = "story"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Worksheet

                                                                                        -
                                                                                        Worksheet: = "worksheet"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.sortdirection.html b/website/static/api/enums/tableau.sortdirection.html deleted file mode 100644 index 166d5713..00000000 --- a/website/static/api/enums/tableau.sortdirection.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - SortDirection | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration SortDirection

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Decreasing

                                                                                        -
                                                                                        Decreasing: = "decreasing"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Increasing

                                                                                        -
                                                                                        Increasing: = "increasing"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.tableaueventtype.html b/website/static/api/enums/tableau.tableaueventtype.html deleted file mode 100644 index 131b8cff..00000000 --- a/website/static/api/enums/tableau.tableaueventtype.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - TableauEventType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration TableauEventType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Represents the type of event that can be listened for.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        All Extensions Enumeration members

                                                                                        - -

                                                                                        Dashboard Extensions Enumeration members

                                                                                        - -

                                                                                        Viz Extensions Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        All Extensions Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        DialogMessageReceived

                                                                                        -
                                                                                        DialogMessageReceived: = "dialog-message-received"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        experimental
                                                                                        -

                                                                                        Raised when a message is received that was sent by a dialog or extension via sendDialogMessageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        FilterChanged

                                                                                        -
                                                                                        FilterChanged: = "filter-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Raised when any filter has changed state. You can use this event type with Worksheet objects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        MarkSelectionChanged

                                                                                        -
                                                                                        MarkSelectionChanged: = "mark-selection-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The selected marks on a visualization has changed. - You can use this event type with Worksheet objects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        ParameterChanged

                                                                                        -
                                                                                        ParameterChanged: = "parameter-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        A parameter has had its value modified. You can use this event type with Parameter objects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        SettingsChanged

                                                                                        -
                                                                                        SettingsChanged: = "settings-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Settings have been changed for this extension. You can use this event type with Settings objects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        SummaryDataChanged

                                                                                        -
                                                                                        SummaryDataChanged: = "summary-data-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The summary data backing a worksheet has changed - You can use this event type with Worksheet objects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Dashboard Extensions Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        DashboardLayoutChanged

                                                                                        -
                                                                                        DashboardLayoutChanged: = "dashboard-layout-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The dashboard layout has changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        WorkbookFormattingChanged

                                                                                        -
                                                                                        WorkbookFormattingChanged: = "workbook-formatting-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The workbook formatting has changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Viz Extensions Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        WorksheetFormattingChanged

                                                                                        -
                                                                                        WorksheetFormattingChanged: = "worksheet-formatting-changed"
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        The worksheet formatting has changed

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.trendlinemodeltype.html b/website/static/api/enums/tableau.trendlinemodeltype.html deleted file mode 100644 index 677d5209..00000000 --- a/website/static/api/enums/tableau.trendlinemodeltype.html +++ /dev/null @@ -1,242 +0,0 @@ - - - - - - TrendLineModelType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration TrendLineModelType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Exponential

                                                                                        -
                                                                                        Exponential: = "exponential"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Linear

                                                                                        -
                                                                                        Linear: = "linear"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Logarithmic

                                                                                        -
                                                                                        Logarithmic: = "logarithmic"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Polynomial

                                                                                        -
                                                                                        Polynomial: = "polynomial"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.vizimageencodingtype.html b/website/static/api/enums/tableau.vizimageencodingtype.html deleted file mode 100644 index ed5bef27..00000000 --- a/website/static/api/enums/tableau.vizimageencodingtype.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - VizImageEncodingType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration VizImageEncodingType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the data type of encodings for createVizImageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.6.0

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Continuous

                                                                                        -
                                                                                        Continuous: = "continuous"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Discrete

                                                                                        -
                                                                                        Discrete: = "discrete"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.vizimagepalettetype.html b/website/static/api/enums/tableau.vizimagepalettetype.html deleted file mode 100644 index 86c4d112..00000000 --- a/website/static/api/enums/tableau.vizimagepalettetype.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - VizImagePaletteType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration VizImagePaletteType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the palette type for createVizImageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.8.0 and Tableau 2021.4

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        CustomDiverging

                                                                                        -
                                                                                        CustomDiverging: = "custom-diverging"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        CustomSequential

                                                                                        -
                                                                                        CustomSequential: = "custom-sequential"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html b/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html deleted file mode 100644 index 4813be2b..00000000 --- a/website/static/api/enums/tableau.vizimagesizesettingalignmenttype.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - VizImageSizeSettingAlignmentType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration VizImageSizeSettingAlignmentType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the Size Setting alignment type for createVizImageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.8.0 and Tableau 2021.4

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Center

                                                                                        -
                                                                                        Center: = "center"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Left

                                                                                        -
                                                                                        Left: = "left"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Right

                                                                                        -
                                                                                        Right: = "right"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.vizimagesizesettingtype.html b/website/static/api/enums/tableau.vizimagesizesettingtype.html deleted file mode 100644 index 7480ef4a..00000000 --- a/website/static/api/enums/tableau.vizimagesizesettingtype.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - VizImageSizeSettingType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration VizImageSizeSettingType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the Size Setting type for createVizImageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.8.0 and Tableau 2021.4

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Fixed

                                                                                        -
                                                                                        Fixed: = "fixed"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Manual

                                                                                        -
                                                                                        Manual: = "manual"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/enums/tableau.vizimagesortdirectiontype.html b/website/static/api/enums/tableau.vizimagesortdirectiontype.html deleted file mode 100644 index e2021537..00000000 --- a/website/static/api/enums/tableau.vizimagesortdirectiontype.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - VizImageSortDirectionType | Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Enumeration VizImageSortDirectionType

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enum that represents the sort direction for createVizImageAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        since
                                                                                        -

                                                                                        1.8.0 and Tableau 2021.4

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Enumeration members

                                                                                        -
                                                                                        - -

                                                                                        Ascending

                                                                                        -
                                                                                        Ascending: = "ascending"
                                                                                        - -
                                                                                        -
                                                                                        - -

                                                                                        Descending

                                                                                        -
                                                                                        Descending: = "descending"
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/globals.html b/website/static/api/globals.html deleted file mode 100644 index d5fefec5..00000000 --- a/website/static/api/globals.html +++ /dev/null @@ -1,673 +0,0 @@ - - - - - - Tableau Extensions - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - Options -
                                                                                        -
                                                                                        - All -
                                                                                          -
                                                                                        • Public
                                                                                          • -
                                                                                        • Public/Protected
                                                                                          • -
                                                                                        • All
                                                                                          • -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        - Menu -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Tableau Extensions

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Index

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Modules

                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Enumerations

                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        All Extensions Interfaces

                                                                                        - -

                                                                                        Dashboard Extensions Interfaces

                                                                                        - -

                                                                                        Viz Extensions Interfaces

                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        All Extensions Type aliases

                                                                                        - -

                                                                                        Dashboard Extensions Type aliases

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        All Extensions Type aliases

                                                                                        -
                                                                                        - -

                                                                                        CategoricalValue

                                                                                        -
                                                                                        CategoricalValue: string | Array<string>
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Categorical values for selection.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        TableauEventHandlerFn

                                                                                        -
                                                                                        TableauEventHandlerFn: (event: TableauEvent) => void
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Callback function which will be invoked when an event notification is emitted.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        param
                                                                                        -

                                                                                        Class representing the event which occurred.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Type declaration

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        TableauEventUnregisterFn

                                                                                        -
                                                                                        TableauEventUnregisterFn: () => boolean
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Function which can be invoked to remove an event handler registration. This will be - returned when registering an event and makes unregistering simpler.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        returns
                                                                                        -

                                                                                        Whether or not the unregistration was successful.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Type declaration

                                                                                        -
                                                                                          -
                                                                                        • -
                                                                                            -
                                                                                          • (): boolean
                                                                                            • -
                                                                                          -
                                                                                            -
                                                                                          • -

                                                                                            Returns boolean

                                                                                            -
                                                                                            • -
                                                                                          -
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        WorksheetFormatting

                                                                                        -
                                                                                        WorksheetFormatting: WorkbookFormatting
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Dashboard Extensions Type aliases

                                                                                        -
                                                                                        - -

                                                                                        DashboardLayoutChangeDetails

                                                                                        -
                                                                                        DashboardLayoutChangeDetails: Map<number, Array<DashboardLayoutChange>>
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Map object that is used for the DashboardLayoutChangedEvent.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        DashboardObjectPositionAndSizeUpdateArray

                                                                                        -
                                                                                        DashboardObjectPositionAndSizeUpdateArray: Array<DashboardObjectPositionAndSizeUpdate>
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Array object that can be passed into moveAndResizeDashboardObjects.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        DashboardObjectVisibilityMap

                                                                                        -
                                                                                        DashboardObjectVisibilityMap: Map<number, DashboardObjectVisibilityType>
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Map object that can be passed into setDashboardObjectVisibilityAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        ZoneVisibilityMap

                                                                                        -
                                                                                        ZoneVisibilityMap: Map<number, ZoneVisibilityType> | object
                                                                                        - -
                                                                                        -
                                                                                        -

                                                                                        Map object that can be passed into setZoneVisibilityAsync.

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        deprecated
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Legend

                                                                                        -
                                                                                        -
                                                                                          -
                                                                                        • Module
                                                                                          • -
                                                                                        • Object literal
                                                                                          • -
                                                                                        • Variable
                                                                                          • -
                                                                                        • Function
                                                                                          • -
                                                                                        • Function with type parameter
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        • Type alias
                                                                                          • -
                                                                                        • Type alias with type parameter
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Enumeration
                                                                                          • -
                                                                                        • Enumeration member
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Interface
                                                                                          • -
                                                                                        • Interface with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Class
                                                                                          • -
                                                                                        • Class with type parameter
                                                                                          • -
                                                                                        • Constructor
                                                                                          • -
                                                                                        • Property
                                                                                          • -
                                                                                        • Method
                                                                                          • -
                                                                                        • Accessor
                                                                                          • -
                                                                                        • Index signature
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Inherited constructor
                                                                                          • -
                                                                                        • Inherited property
                                                                                          • -
                                                                                        • Inherited method
                                                                                          • -
                                                                                        • Inherited accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Protected property
                                                                                          • -
                                                                                        • Protected method
                                                                                          • -
                                                                                        • Protected accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Private property
                                                                                          • -
                                                                                        • Private method
                                                                                          • -
                                                                                        • Private accessor
                                                                                          • -
                                                                                        -
                                                                                          -
                                                                                        • Static property
                                                                                          • -
                                                                                        • Static method
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - - - - \ No newline at end of file diff --git a/website/static/api/hierarchy.html b/website/static/api/hierarchy.html new file mode 100644 index 00000000..34678c17 --- /dev/null +++ b/website/static/api/hierarchy.html @@ -0,0 +1,25 @@ +Tableau Extensions API
                                                                                        Tableau Extensions API
                                                                                          Preparing search index...

                                                                                          Tableau Extensions API

                                                                                          Hierarchy Summary

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          diff --git a/website/static/api/index.html b/website/static/api/index.html index 567d6f21..aa610b2d 100644 --- a/website/static/api/index.html +++ b/website/static/api/index.html @@ -1,463 +1,78 @@ - - - - - - Tableau Extensions - - - - - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - Options -
                                                                                          -
                                                                                          - All -
                                                                                            -
                                                                                          • Public
                                                                                            • -
                                                                                          • Public/Protected
                                                                                            • -
                                                                                          • All
                                                                                            • -
                                                                                          -
                                                                                          - - - - -
                                                                                          -
                                                                                          - Menu -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -

                                                                                          Tableau Extensions

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -

                                                                                          Tableau Extensions API

                                                                                          -                                                                                           -

                                                                                          Version: 1.16.0 (February 2026)

                                                                                          -

                                                                                          The Tableau Extensions API is a JavaScript library that is organized into namespaces that contain - the classes and methods for communicating with Tableau components. The Tableau Extensions API - library supports both dashboard extensions and viz extensions, although not - all interfaces and methods apply to both extensions. For an overview of how the API is organized, - see Tableau Extensions API Basics.

                                                                                          -
                                                                                          - Note: To see all the methods and properties for the Extensions API interfaces, select the Inherited option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes. -
                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                          NamespaceDescription
                                                                                          TableauThe top-level or global namespace is the tableau namespace, which has no constructs, but contains the extensions namespace. You use the tableau namespace to access the extensions. For example, you call tableau.extensions.initializeAsync() to initialize the API.
                                                                                          ExtensionsThe extensions namespace is the namespace for Tableau extensions. A dashboard extension is one type of extension. A dashboard extension has access to the dashboardContent namespace, and all the objects and classes of the dashboard. Some namespaces, like the settings, environment, and ui are available to all extensions.
                                                                                          DashboardContent(Available to dashboard extensions only) The dashboardContent provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the dashboard, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheets in a dashboard (after initialization), you might have a line of code that looks like the following:
                                                                                          const worksheets = tableau.extensions.dashboardContent.dashboard.worksheets
                                                                                          WorksheetContent(Available to viz extensions only) The worksheetContent provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the worksheet, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following:
                                                                                          const worksheet = tableau.extensions.worksheetContent
                                                                                          SettingsThe settings namespace provides methods to get and set values which will be persisted in a workbook. You can use the settings to configure an extension.
                                                                                          EnvironmentThe environment namespace provides methods to programmatically gather information about the environment in which the extension is running.
                                                                                          UIThe ui namespace provides methods for an extension to display a popup dialog window.
                                                                                          - -

                                                                                          Dashboard extensions

                                                                                          -                                                                                           -

                                                                                          The following diagram shows the relationship between the extensions namespace and the worksheets in - the dashboard. For more information, see Tableau Extensions API Basics.

                                                                                          -

                                                                                          Extensions API namespace hierarchy

                                                                                          -
                                                                                          - -

                                                                                          Viz extensions

                                                                                          -                                                                                           -

                                                                                          The following diagram shows the relationship between the extensions namespace and the worksheets in - the workbook. For more information, see Tableau Extensions API Basics.

                                                                                          -

                                                                                          Viz Extensions API namespace hierarchy

                                                                                          - -
                                                                                          -
                                                                                          - -

                                                                                          © Copyright Salesforce, Inc. All rights reserved. Various trademarks held by their respective owners. - Salesforce, Inc. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -
                                                                                          -
                                                                                          +Tableau Extensions API
                                                                                          Tableau Extensions API
                                                                                            Preparing search index...

                                                                                            Tableau Extensions API

                                                                                            The Tableau Extensions API is a JavaScript library that is organized into namespaces that contain +the classes and methods for communicating with Tableau components. The Tableau Extensions API +library supports both dashboard extensions and viz extensions, although not +all interfaces and methods apply to both extensions. For an overview of how the API is organized, +see Tableau Extensions API Basics.

                                                                                            +
                                                                                            + Note: To see all the methods and properties for the Extensions API interfaces, select the Inherited option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes.
                                                                                            -
                                                                                            -
                                                                                            -

                                                                                            Legend

                                                                                            -
                                                                                            -
                                                                                              -
                                                                                            • Module
                                                                                              • -
                                                                                            • Object literal
                                                                                              • -
                                                                                            • Variable
                                                                                              • -
                                                                                            • Function
                                                                                              • -
                                                                                            • Function with type parameter
                                                                                              • -
                                                                                            • Index signature
                                                                                              • -
                                                                                            • Type alias
                                                                                              • -
                                                                                            • Type alias with type parameter
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Enumeration
                                                                                              • -
                                                                                            • Enumeration member
                                                                                              • -
                                                                                            • Property
                                                                                              • -
                                                                                            • Method
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Interface
                                                                                              • -
                                                                                            • Interface with type parameter
                                                                                              • -
                                                                                            • Constructor
                                                                                              • -
                                                                                            • Property
                                                                                              • -
                                                                                            • Method
                                                                                              • -
                                                                                            • Index signature
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Class
                                                                                              • -
                                                                                            • Class with type parameter
                                                                                              • -
                                                                                            • Constructor
                                                                                              • -
                                                                                            • Property
                                                                                              • -
                                                                                            • Method
                                                                                              • -
                                                                                            • Accessor
                                                                                              • -
                                                                                            • Index signature
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Inherited constructor
                                                                                              • -
                                                                                            • Inherited property
                                                                                              • -
                                                                                            • Inherited method
                                                                                              • -
                                                                                            • Inherited accessor
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Protected property
                                                                                              • -
                                                                                            • Protected method
                                                                                              • -
                                                                                            • Protected accessor
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Private property
                                                                                              • -
                                                                                            • Private method
                                                                                              • -
                                                                                            • Private accessor
                                                                                              • -
                                                                                            -
                                                                                              -
                                                                                            • Static property
                                                                                              • -
                                                                                            • Static method
                                                                                              • -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            - - - - - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            NamespaceDescription
                                                                                            TableauThe top-level or global namespace is the tableau namespace, which has no constructs, but contains the extensions namespace. You use the tableau namespace to access the extensions. For example, you call tableau.extensions.initializeAsync() to initialize the API.
                                                                                            ExtensionsThe extensions namespace is the namespace for Tableau extensions. A dashboard extension is one type of extension. A dashboard extension has access to the dashboardContent namespace, and all the objects and classes of the dashboard. Some namespaces, like the settings, environment, and ui are available to all extensions.
                                                                                            DashboardContent(Available to dashboard extensions only) The dashboardContent provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the dashboard, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheets in a dashboard (after initialization), you might have a line of code that looks like the following:
                                                                                            const worksheets = tableau.extensions.dashboardContent.dashboard.worksheets
                                                                                            WorksheetContent(Available to viz extensions only) The worksheetContent provides access to the worksheet object. When you have the worksheet object, you have access to all elements in the worksheet, including the worksheets, marks, filters, parameters, and data sources. For example, to access the worksheet in a workbook (after initialization), you might have a line of code that looks like the following:
                                                                                            const worksheet = tableau.extensions.worksheetContent
                                                                                            SettingsThe settings namespace provides methods to get and set values which will be persisted in a workbook. You can use the settings to configure an extension.
                                                                                            EnvironmentThe environment namespace provides methods to programmatically gather information about the environment in which the extension is running.
                                                                                            UIThe ui namespace provides methods for an extension to display a popup dialog window.
                                                                                            +

                                                                                            The following diagram shows the relationship between the extensions namespace and the worksheets in +the dashboard. For more information, see Tableau Extensions API Basics.

                                                                                            +

                                                                                            Extensions API namespace hierarchy

                                                                                            +
                                                                                            +

                                                                                            The following diagram shows the relationship between the extensions namespace and the worksheets in +the workbook. For more information, see Tableau Extensions API Basics.

                                                                                            +

                                                                                            Viz Extensions API namespace hierarchy

                                                                                            +

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Dashboard extensionsViz extensions
                                                                                            diff --git a/website/static/api/interfaces/DataFormattingOptions.html b/website/static/api/interfaces/DataFormattingOptions.html new file mode 100644 index 00000000..7294f3d9 --- /dev/null +++ b/website/static/api/interfaces/DataFormattingOptions.html @@ -0,0 +1,55 @@ +DataFormattingOptions | Tableau Extensions API
                                                                                            Tableau Extensions API
                                                                                              Preparing search index...

                                                                                              Interface DataFormattingOptions

                                                                                              1.16.0 +Formatting options for a number or date column

                                                                                              +
                                                                                              interface DataFormattingOptions {
                                                                                                  customFormatString: string;
                                                                                                  decimalCharacter: string;
                                                                                                  decimals: number;
                                                                                                  formatType: DataFormatType;
                                                                                                  locale: string;
                                                                                                  negativeFormat: NegativeNumberFormat;
                                                                                                  prefix: string;
                                                                                                  separatorCharacter: string;
                                                                                                  showSeparators: boolean;
                                                                                                  suffix: string;
                                                                                                  units: NumberFormatUnits;
                                                                                              }
                                                                                              Index

                                                                                              Properties

                                                                                              customFormatString +decimalCharacter +decimals +formatType +locale +negativeFormat +prefix +separatorCharacter +showSeparators +suffix +units +

                                                                                              Properties

                                                                                              customFormatString: string

                                                                                              The custom format string to display for the value. +For more information on number formats, see Format Numbers and Null Values. +When the custom format string is used for numbers, other formatting options are ignored. +For information on formatting dates, see Custom Date Formats. +The custom format string is always used for dates and the other formatting options do not apply (except for the formatType and locale).

                                                                                              +
                                                                                              decimalCharacter: string

                                                                                              The character to use as the decimal point.

                                                                                              +
                                                                                              decimals: number

                                                                                              The number of digits to display after the decimal point.

                                                                                              +
                                                                                              formatType: DataFormatType

                                                                                              The type of the format. +Can specify number, currency, date, time, percentage, scientific, or auto-format (default). +For numbers, can also specify custom number format.

                                                                                              +
                                                                                              locale: string

                                                                                              The locale of the format (e.g. en-US, fr-FR, etc.).

                                                                                              +
                                                                                              negativeFormat: NegativeNumberFormat

                                                                                              The format for displaying .

                                                                                              +
                                                                                              prefix: string

                                                                                              The prefix to display before the value.

                                                                                              +
                                                                                              separatorCharacter: string

                                                                                              The character to use as the thousand separator.

                                                                                              +
                                                                                              showSeparators: boolean

                                                                                              Whether to show thousand separators.

                                                                                              +
                                                                                              suffix: string

                                                                                              The suffix to display after the value.

                                                                                              +
                                                                                              units: NumberFormatUnits

                                                                                              Display the number using specified units (e.g. K for thousands, M for millions, B for billions, etc.).

                                                                                              +

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Properties
                                                                                              diff --git a/website/static/api/interfaces/WorksheetFormatting.html b/website/static/api/interfaces/WorksheetFormatting.html new file mode 100644 index 00000000..5bc2bb68 --- /dev/null +++ b/website/static/api/interfaces/WorksheetFormatting.html @@ -0,0 +1,28 @@ +WorksheetFormatting | Tableau Extensions API
                                                                                              Tableau Extensions API
                                                                                                Preparing search index...

                                                                                                Interface WorksheetFormatting

                                                                                                interface WorksheetFormatting {
                                                                                                    formattingSheets: FormattingSheet[];
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                formattingSheets +

                                                                                                Properties

                                                                                                formattingSheets: FormattingSheet[]

                                                                                                An array of formatting sheets that contain the css properties for a worksheet.

                                                                                                +

                                                                                                1.29.0 and Tableau 2025.3

                                                                                                +

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                diff --git a/website/static/api/interfaces/annotation.html b/website/static/api/interfaces/annotation.html index add3981d..b6e92528 100644 --- a/website/static/api/interfaces/annotation.html +++ b/website/static/api/interfaces/annotation.html @@ -1,300 +1,36 @@ - - - - - - Annotation | Tableau Extensions - - - - - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - Options -
                                                                                                -
                                                                                                - All -
                                                                                                  -
                                                                                                • Public
                                                                                                  • -
                                                                                                • Public/Protected
                                                                                                  • -
                                                                                                • All
                                                                                                  • -
                                                                                                -
                                                                                                - - - - -
                                                                                                -
                                                                                                - Menu -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                Interface Annotation

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Represents an annotation in a worksheet.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Hierarchy

                                                                                                -
                                                                                                  -
                                                                                                • - Annotation -
                                                                                                  • -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Index

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Properties

                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Properties

                                                                                                -
                                                                                                - -

                                                                                                annotationHTML

                                                                                                -
                                                                                                annotationHTML: string
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                returns
                                                                                                -

                                                                                                The formatted annotation as a HTML string. HTML is currently not accepted when adding an annotation.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                annotationId

                                                                                                -
                                                                                                annotationId: number
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                returns
                                                                                                -

                                                                                                Unique id representing the annotation.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                annotationText

                                                                                                -
                                                                                                annotationText: string
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                returns
                                                                                                -

                                                                                                The plain text of the annotation.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                annotationType

                                                                                                -
                                                                                                annotationType: AnnotationType
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                returns
                                                                                                -

                                                                                                The annotation type.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - -

                                                                                                tupleId

                                                                                                -
                                                                                                tupleId: number
                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                returns
                                                                                                -

                                                                                                Unique tuple representing the mark that is being annotated. The tupleId will be 0 for Area or Point annotations.

                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Legend

                                                                                                -
                                                                                                -
                                                                                                  -
                                                                                                • Module
                                                                                                  • -
                                                                                                • Object literal
                                                                                                  • -
                                                                                                • Variable
                                                                                                  • -
                                                                                                • Function
                                                                                                  • -
                                                                                                • Function with type parameter
                                                                                                  • -
                                                                                                • Index signature
                                                                                                  • -
                                                                                                • Type alias
                                                                                                  • -
                                                                                                • Type alias with type parameter
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Enumeration
                                                                                                  • -
                                                                                                • Enumeration member
                                                                                                  • -
                                                                                                • Property
                                                                                                  • -
                                                                                                • Method
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Interface
                                                                                                  • -
                                                                                                • Interface with type parameter
                                                                                                  • -
                                                                                                • Constructor
                                                                                                  • -
                                                                                                • Property
                                                                                                  • -
                                                                                                • Method
                                                                                                  • -
                                                                                                • Index signature
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Class
                                                                                                  • -
                                                                                                • Class with type parameter
                                                                                                  • -
                                                                                                • Constructor
                                                                                                  • -
                                                                                                • Property
                                                                                                  • -
                                                                                                • Method
                                                                                                  • -
                                                                                                • Accessor
                                                                                                  • -
                                                                                                • Index signature
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Inherited constructor
                                                                                                  • -
                                                                                                • Inherited property
                                                                                                  • -
                                                                                                • Inherited method
                                                                                                  • -
                                                                                                • Inherited accessor
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Protected property
                                                                                                  • -
                                                                                                • Protected method
                                                                                                  • -
                                                                                                • Protected accessor
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Private property
                                                                                                  • -
                                                                                                • Private method
                                                                                                  • -
                                                                                                • Private accessor
                                                                                                  • -
                                                                                                -
                                                                                                  -
                                                                                                • Static property
                                                                                                  • -
                                                                                                • Static method
                                                                                                  • -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - - - - \ No newline at end of file +Annotation | Tableau Extensions API
                                                                                                Tableau Extensions API
                                                                                                  Preparing search index...

                                                                                                  Interface Annotation

                                                                                                  Represents an annotation in a worksheet.

                                                                                                  +
                                                                                                  interface Annotation {
                                                                                                      annotationHTML: string;
                                                                                                      annotationId: number;
                                                                                                      annotationText: string;
                                                                                                      annotationType: AnnotationType;
                                                                                                      tupleId: number;
                                                                                                  }
                                                                                                  Index

                                                                                                  Properties

                                                                                                  annotationHTML +annotationId +annotationText +annotationType +tupleId +

                                                                                                  Properties

                                                                                                  annotationHTML: string

                                                                                                  The formatted annotation as a HTML string. HTML is currently not accepted when adding an annotation.

                                                                                                  +
                                                                                                  annotationId: number

                                                                                                  Unique id representing the annotation.

                                                                                                  +
                                                                                                  annotationText: string

                                                                                                  The plain text of the annotation.

                                                                                                  +
                                                                                                  annotationType: AnnotationType

                                                                                                  The annotation type.

                                                                                                  +
                                                                                                  tupleId: number

                                                                                                  Unique tuple representing the mark that is being annotated. The tupleId will be 0 for Area or Point annotations.

                                                                                                  +

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Properties
                                                                                                  diff --git a/website/static/api/interfaces/categoricaldomain.html b/website/static/api/interfaces/categoricaldomain.html index cf324ee0..a58f9004 100644 --- a/website/static/api/interfaces/categoricaldomain.html +++ b/website/static/api/interfaces/categoricaldomain.html @@ -1,237 +1,30 @@ - - - - - - CategoricalDomain | Tableau Extensions - - - - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - Options -
                                                                                                  -
                                                                                                  - All -
                                                                                                    -
                                                                                                  • Public
                                                                                                    • -
                                                                                                  • Public/Protected
                                                                                                    • -
                                                                                                  • All
                                                                                                    • -
                                                                                                  -
                                                                                                  - - - - -
                                                                                                  -
                                                                                                  - Menu -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -

                                                                                                  Interface CategoricalDomain

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  The domain of a categorical filter

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Hierarchy

                                                                                                  -
                                                                                                    -
                                                                                                  • - CategoricalDomain -
                                                                                                    • -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Index

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Properties

                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Properties

                                                                                                  -
                                                                                                  - -

                                                                                                  type

                                                                                                  -
                                                                                                  type: FilterDomainType
                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                  returns
                                                                                                  -

                                                                                                  the domain type (relevant, all)

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -

                                                                                                  values

                                                                                                  -
                                                                                                  values: Array<DataValue>
                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                  returns
                                                                                                  -

                                                                                                  the list of values in the domain of the filter

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Legend

                                                                                                  -
                                                                                                  -
                                                                                                    -
                                                                                                  • Module
                                                                                                    • -
                                                                                                  • Object literal
                                                                                                    • -
                                                                                                  • Variable
                                                                                                    • -
                                                                                                  • Function
                                                                                                    • -
                                                                                                  • Function with type parameter
                                                                                                    • -
                                                                                                  • Index signature
                                                                                                    • -
                                                                                                  • Type alias
                                                                                                    • -
                                                                                                  • Type alias with type parameter
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Enumeration
                                                                                                    • -
                                                                                                  • Enumeration member
                                                                                                    • -
                                                                                                  • Property
                                                                                                    • -
                                                                                                  • Method
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Interface
                                                                                                    • -
                                                                                                  • Interface with type parameter
                                                                                                    • -
                                                                                                  • Constructor
                                                                                                    • -
                                                                                                  • Property
                                                                                                    • -
                                                                                                  • Method
                                                                                                    • -
                                                                                                  • Index signature
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Class
                                                                                                    • -
                                                                                                  • Class with type parameter
                                                                                                    • -
                                                                                                  • Constructor
                                                                                                    • -
                                                                                                  • Property
                                                                                                    • -
                                                                                                  • Method
                                                                                                    • -
                                                                                                  • Accessor
                                                                                                    • -
                                                                                                  • Index signature
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Inherited constructor
                                                                                                    • -
                                                                                                  • Inherited property
                                                                                                    • -
                                                                                                  • Inherited method
                                                                                                    • -
                                                                                                  • Inherited accessor
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Protected property
                                                                                                    • -
                                                                                                  • Protected method
                                                                                                    • -
                                                                                                  • Protected accessor
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Private property
                                                                                                    • -
                                                                                                  • Private method
                                                                                                    • -
                                                                                                  • Private accessor
                                                                                                    • -
                                                                                                  -
                                                                                                    -
                                                                                                  • Static property
                                                                                                    • -
                                                                                                  • Static method
                                                                                                    • -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - - - - \ No newline at end of file +CategoricalDomain | Tableau Extensions API
                                                                                                  Tableau Extensions API
                                                                                                    Preparing search index...

                                                                                                    Interface CategoricalDomain

                                                                                                    The domain of a categorical filter

                                                                                                    +
                                                                                                    interface CategoricalDomain {
                                                                                                        type: FilterDomainType;
                                                                                                        values: DataValue[];
                                                                                                    }
                                                                                                    Index

                                                                                                    Properties

                                                                                                    type +values +

                                                                                                    Properties

                                                                                                    type: FilterDomainType

                                                                                                    the domain type (relevant, all)

                                                                                                    +
                                                                                                    values: DataValue[]

                                                                                                    the list of values in the domain of the filter

                                                                                                    +

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    diff --git a/website/static/api/interfaces/categoricalfilter.html b/website/static/api/interfaces/categoricalfilter.html index 3bb3171e..6b84c5ee 100644 --- a/website/static/api/interfaces/categoricalfilter.html +++ b/website/static/api/interfaces/categoricalfilter.html @@ -1,500 +1,62 @@ - - - - - - CategoricalFilter | Tableau Extensions - - - - - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    - Options -
                                                                                                    -
                                                                                                    - All -
                                                                                                      -
                                                                                                    • Public
                                                                                                      • -
                                                                                                    • Public/Protected
                                                                                                      • -
                                                                                                    • All
                                                                                                      • -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    -
                                                                                                    - Menu -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    Interface CategoricalFilter

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    A Categorical Filter

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Hierarchy

                                                                                                    -
                                                                                                      -
                                                                                                    • - Filter -
                                                                                                        -
                                                                                                      • - CategoricalFilter -
                                                                                                        • -
                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Index

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Properties

                                                                                                    - -
                                                                                                    -
                                                                                                    -

                                                                                                    Methods

                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Properties

                                                                                                    -
                                                                                                    - -

                                                                                                    appliedValues

                                                                                                    -
                                                                                                    appliedValues: Array<DataValue>
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    A list of values applied to this categorical filter. Notice that if this is a - dependent filter, the current relavent values can be fetched by calling - getDomainAsync(tableau.FilterDomainType.Relevant).

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    fieldId

                                                                                                    -
                                                                                                    fieldId: string
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    The id of the field being filtered.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    fieldName

                                                                                                    -
                                                                                                    fieldName: string
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    The name of the field being filtered. Note that this is the caption - as shown in the UI, and not the actual database field name.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    filterType

                                                                                                    -
                                                                                                    filterType: FilterType
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    The type of the filter.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    Optional isAllSelected

                                                                                                    -
                                                                                                    isAllSelected: undefined | false | true
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    True if all the values are selected for this filter. When 'All' is selected, - appliedValues returns an empty list.

                                                                                                    -

                                                                                                    This field is available in Tableau 2019.2 or later

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    isExcludeMode

                                                                                                    -
                                                                                                    isExcludeMode: boolean
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    True if this filter is an exclude filter, false if an include filter.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    worksheetName

                                                                                                    -
                                                                                                    worksheetName: string
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    returns
                                                                                                    -

                                                                                                    The parent worksheet.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Methods

                                                                                                    -
                                                                                                    - -

                                                                                                    getAppliedWorksheetsAsync

                                                                                                    -
                                                                                                      -
                                                                                                    • getAppliedWorksheetsAsync(): Promise<Array<string>>
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • - -
                                                                                                      -
                                                                                                      -
                                                                                                      since
                                                                                                      -

                                                                                                      1.9.0 and Tableau 2022.2

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Returns Promise<Array<string>>

                                                                                                      -

                                                                                                      the list of worksheet names that have the filter applied.

                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    getDomainAsync

                                                                                                    - -
                                                                                                      -
                                                                                                    • - -
                                                                                                      -
                                                                                                      -

                                                                                                      Parameters

                                                                                                      - -

                                                                                                      Returns Promise<CategoricalDomain>

                                                                                                      -

                                                                                                      a promise containing the categorical domain for the filter. Note if a filter contains - multiple fields (such as a filter action with multiple fields), the values array in the returned - CategoricalDomain (CategoricalDomain.values) will be empty. If there are multiple fields - in the filter, the results need to be represented by a table, which is not currently supported.

                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    getFieldAsync

                                                                                                    -
                                                                                                      -
                                                                                                    • getFieldAsync(): Promise<Field>
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • - -
                                                                                                      -
                                                                                                      -
                                                                                                      since
                                                                                                      -

                                                                                                      1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Returns Promise<Field>

                                                                                                      -

                                                                                                      a promise containing the field for the filter.

                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    setAppliedWorksheetsAsync

                                                                                                    -
                                                                                                      -
                                                                                                    • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • - -
                                                                                                      -
                                                                                                      -

                                                                                                      Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      since
                                                                                                      -

                                                                                                      1.9.0 and Tableau 2022.2

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Parameters

                                                                                                      -
                                                                                                        -
                                                                                                      • -
                                                                                                        applyToWorksheets: Array<string>
                                                                                                        -
                                                                                                        -

                                                                                                        list of worksheets to apply the filter on

                                                                                                        -
                                                                                                        -
                                                                                                        • -
                                                                                                      -

                                                                                                      Returns Promise<Array<string>>

                                                                                                      -

                                                                                                      the list of worksheet names that have the filter applied

                                                                                                      -
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Legend

                                                                                                    -
                                                                                                    -
                                                                                                      -
                                                                                                    • Module
                                                                                                      • -
                                                                                                    • Object literal
                                                                                                      • -
                                                                                                    • Variable
                                                                                                      • -
                                                                                                    • Function
                                                                                                      • -
                                                                                                    • Function with type parameter
                                                                                                      • -
                                                                                                    • Index signature
                                                                                                      • -
                                                                                                    • Type alias
                                                                                                      • -
                                                                                                    • Type alias with type parameter
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Enumeration
                                                                                                      • -
                                                                                                    • Enumeration member
                                                                                                      • -
                                                                                                    • Property
                                                                                                      • -
                                                                                                    • Method
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Interface
                                                                                                      • -
                                                                                                    • Interface with type parameter
                                                                                                      • -
                                                                                                    • Constructor
                                                                                                      • -
                                                                                                    • Property
                                                                                                      • -
                                                                                                    • Method
                                                                                                      • -
                                                                                                    • Index signature
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Class
                                                                                                      • -
                                                                                                    • Class with type parameter
                                                                                                      • -
                                                                                                    • Constructor
                                                                                                      • -
                                                                                                    • Property
                                                                                                      • -
                                                                                                    • Method
                                                                                                      • -
                                                                                                    • Accessor
                                                                                                      • -
                                                                                                    • Index signature
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Inherited constructor
                                                                                                      • -
                                                                                                    • Inherited property
                                                                                                      • -
                                                                                                    • Inherited method
                                                                                                      • -
                                                                                                    • Inherited accessor
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Protected property
                                                                                                      • -
                                                                                                    • Protected method
                                                                                                      • -
                                                                                                    • Protected accessor
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Private property
                                                                                                      • -
                                                                                                    • Private method
                                                                                                      • -
                                                                                                    • Private accessor
                                                                                                      • -
                                                                                                    -
                                                                                                      -
                                                                                                    • Static property
                                                                                                      • -
                                                                                                    • Static method
                                                                                                      • -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - - - - \ No newline at end of file +CategoricalFilter | Tableau Extensions API
                                                                                                    Tableau Extensions API
                                                                                                      Preparing search index...

                                                                                                      Interface CategoricalFilter

                                                                                                      A Categorical Filter

                                                                                                      +
                                                                                                      interface CategoricalFilter {
                                                                                                          appliedValues: DataValue[];
                                                                                                          fieldId: string;
                                                                                                          fieldName: string;
                                                                                                          filterType: FilterType;
                                                                                                          isAllSelected?: boolean;
                                                                                                          isExcludeMode: boolean;
                                                                                                          worksheetName: string;
                                                                                                          getAppliedWorksheetsAsync(): Promise<string[]>;
                                                                                                          getDomainAsync(domainType?: FilterDomainType): Promise<CategoricalDomain>;
                                                                                                          getFieldAsync(): Promise<Field>;
                                                                                                          setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
                                                                                                      }

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Properties

                                                                                                      appliedValues +fieldId +fieldName +filterType +isAllSelected? +isExcludeMode +worksheetName +

                                                                                                      Methods

                                                                                                      getAppliedWorksheetsAsync +getDomainAsync +getFieldAsync +setAppliedWorksheetsAsync +

                                                                                                      Properties

                                                                                                      appliedValues: DataValue[]

                                                                                                      A list of values applied to this categorical filter. Notice that if this is a +dependent filter, the current relavent values can be fetched by calling +getDomainAsync(tableau.FilterDomainType.Relevant).

                                                                                                      +
                                                                                                      fieldId: string

                                                                                                      The id of the field being filtered.

                                                                                                      +
                                                                                                      fieldName: string

                                                                                                      The name of the field being filtered. Note that this is the caption +as shown in the UI, and not the actual database field name.

                                                                                                      +
                                                                                                      filterType: FilterType

                                                                                                      The type of the filter.

                                                                                                      +
                                                                                                      isAllSelected?: boolean

                                                                                                      True if all the values are selected for this filter. When 'All' is selected, +appliedValues returns an empty list.

                                                                                                      +

                                                                                                      This field is available in Tableau 2019.2 or later

                                                                                                      +
                                                                                                      isExcludeMode: boolean

                                                                                                      True if this filter is an exclude filter, false if an include filter.

                                                                                                      +
                                                                                                      worksheetName: string

                                                                                                      The parent worksheet.

                                                                                                      +

                                                                                                      Methods

                                                                                                      • Returns Promise<string[]>

                                                                                                        the list of worksheet names that have the filter applied.

                                                                                                        +

                                                                                                        1.9.0 and Tableau 2022.2

                                                                                                        +

                                                                                                      • Parameters

                                                                                                        Returns Promise<CategoricalDomain>

                                                                                                        a promise containing the categorical domain for the filter. Note if a filter contains +multiple fields (such as a filter action with multiple fields), the values array in the returned +CategoricalDomain (CategoricalDomain.values) will be empty. If there are multiple fields +in the filter, the results need to be represented by a table, which is not currently supported.

                                                                                                        +

                                                                                                      • Returns Promise<Field>

                                                                                                        a promise containing the field for the filter.

                                                                                                        +

                                                                                                        1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                        +

                                                                                                      • Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • applyToWorksheets: string[]

                                                                                                          list of worksheets to apply the filter on

                                                                                                          +

                                                                                                        Returns Promise<string[]>

                                                                                                        the list of worksheet names that have the filter applied

                                                                                                        +

                                                                                                        1.9.0 and Tableau 2022.2

                                                                                                        +

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Properties
                                                                                                      Methods
                                                                                                      diff --git a/website/static/api/interfaces/column.html b/website/static/api/interfaces/column.html index 3fb5e7be..92ecd682 100644 --- a/website/static/api/interfaces/column.html +++ b/website/static/api/interfaces/column.html @@ -1,302 +1,42 @@ - - - - - - Column | Tableau Extensions - - - - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - Options -
                                                                                                      -
                                                                                                      - All -
                                                                                                        -
                                                                                                      • Public
                                                                                                        • -
                                                                                                      • Public/Protected
                                                                                                        • -
                                                                                                      • All
                                                                                                        • -
                                                                                                      -
                                                                                                      - - - - -
                                                                                                      -
                                                                                                      - Menu -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      Interface Column

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Hierarchy

                                                                                                      -
                                                                                                        -
                                                                                                      • - Column -
                                                                                                        • -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Index

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Properties

                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Properties

                                                                                                      -
                                                                                                      - -

                                                                                                      dataType

                                                                                                      -
                                                                                                      dataType: DataType
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      returns
                                                                                                      -

                                                                                                      The data type of the column. Possible values are - float, integer, string, boolean, date, datetime and spatial

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      fieldId

                                                                                                      -
                                                                                                      fieldId: string
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      returns
                                                                                                      -

                                                                                                      The fieldId of the field in the column. In summary data, this includes the aggregation. - The fieldId is not stable across replacing data sources. - For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become - [federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

                                                                                                      -
                                                                                                      -
                                                                                                      since
                                                                                                      -

                                                                                                      1.5.0

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      fieldName

                                                                                                      -
                                                                                                      fieldName: string
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      returns
                                                                                                      -

                                                                                                      The name of the field in the column. In summary data, this includes the aggregation. - The summary data field name is not stable across languages. - For example, in an English version of Tableau, the field name might be SUM(Sales). In French, this would be SOMME(Sales).

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      index

                                                                                                      -
                                                                                                      index: number
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      returns
                                                                                                      -

                                                                                                      The number of rows in the returned data.

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      isReferenced

                                                                                                      -
                                                                                                      isReferenced: boolean
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      returns
                                                                                                      -

                                                                                                      Whether the column data is referenced in the visualization.

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Legend

                                                                                                      -
                                                                                                      -
                                                                                                        -
                                                                                                      • Module
                                                                                                        • -
                                                                                                      • Object literal
                                                                                                        • -
                                                                                                      • Variable
                                                                                                        • -
                                                                                                      • Function
                                                                                                        • -
                                                                                                      • Function with type parameter
                                                                                                        • -
                                                                                                      • Index signature
                                                                                                        • -
                                                                                                      • Type alias
                                                                                                        • -
                                                                                                      • Type alias with type parameter
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Enumeration
                                                                                                        • -
                                                                                                      • Enumeration member
                                                                                                        • -
                                                                                                      • Property
                                                                                                        • -
                                                                                                      • Method
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Interface
                                                                                                        • -
                                                                                                      • Interface with type parameter
                                                                                                        • -
                                                                                                      • Constructor
                                                                                                        • -
                                                                                                      • Property
                                                                                                        • -
                                                                                                      • Method
                                                                                                        • -
                                                                                                      • Index signature
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Class
                                                                                                        • -
                                                                                                      • Class with type parameter
                                                                                                        • -
                                                                                                      • Constructor
                                                                                                        • -
                                                                                                      • Property
                                                                                                        • -
                                                                                                      • Method
                                                                                                        • -
                                                                                                      • Accessor
                                                                                                        • -
                                                                                                      • Index signature
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Inherited constructor
                                                                                                        • -
                                                                                                      • Inherited property
                                                                                                        • -
                                                                                                      • Inherited method
                                                                                                        • -
                                                                                                      • Inherited accessor
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Protected property
                                                                                                        • -
                                                                                                      • Protected method
                                                                                                        • -
                                                                                                      • Protected accessor
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Private property
                                                                                                        • -
                                                                                                      • Private method
                                                                                                        • -
                                                                                                      • Private accessor
                                                                                                        • -
                                                                                                      -
                                                                                                        -
                                                                                                      • Static property
                                                                                                        • -
                                                                                                      • Static method
                                                                                                        • -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - - - - \ No newline at end of file +Column | Tableau Extensions API
                                                                                                      Tableau Extensions API
                                                                                                        Preparing search index...

                                                                                                        Interface Column

                                                                                                        interface Column {
                                                                                                            dataType: DataType;
                                                                                                            fieldId: string;
                                                                                                            fieldName: string;
                                                                                                            index: number;
                                                                                                            isReferenced: boolean;
                                                                                                        }
                                                                                                        Index

                                                                                                        Properties

                                                                                                        dataType +fieldId +fieldName +index +isReferenced +

                                                                                                        Properties

                                                                                                        dataType: DataType

                                                                                                        The data type of the column. Possible values are +float, integer, string, boolean, date, datetime and spatial

                                                                                                        +
                                                                                                        fieldId: string

                                                                                                        The fieldId of the field in the column. In summary data, this includes the aggregation. +The fieldId is not stable across replacing data sources. +For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become +[federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

                                                                                                        +

                                                                                                        1.5.0

                                                                                                        +
                                                                                                        fieldName: string

                                                                                                        The name of the field in the column. In summary data, this includes the aggregation. +The summary data field name is not stable across languages. +For example, in an English version of Tableau, the field name might be SUM(Sales). In French, this would be SOMME(Sales).

                                                                                                        +
                                                                                                        index: number

                                                                                                        The number of rows in the returned data.

                                                                                                        +
                                                                                                        isReferenced: boolean

                                                                                                        Whether the column data is referenced in the visualization.

                                                                                                        +

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Properties
                                                                                                        diff --git a/website/static/api/interfaces/connectionsummary.html b/website/static/api/interfaces/connectionsummary.html index be2ee8a1..81be8052 100644 --- a/website/static/api/interfaces/connectionsummary.html +++ b/website/static/api/interfaces/connectionsummary.html @@ -1,282 +1,37 @@ - - - - - - ConnectionSummary | Tableau Extensions - - - - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - Options -
                                                                                                        -
                                                                                                        - All -
                                                                                                          -
                                                                                                        • Public
                                                                                                          • -
                                                                                                        • Public/Protected
                                                                                                          • -
                                                                                                        • All
                                                                                                          • -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        -
                                                                                                        - Menu -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        Interface ConnectionSummary

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Represents a connection within a datasource (ex: A SQL Server connection). - A data source can be composed of one or more connections.

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Hierarchy

                                                                                                        -
                                                                                                          -
                                                                                                        • - ConnectionSummary -
                                                                                                          • -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Index

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Properties

                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Properties

                                                                                                        -
                                                                                                        - -

                                                                                                        id

                                                                                                        -
                                                                                                        id: string
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        returns
                                                                                                        -

                                                                                                        Unique string representing this connection.

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        name

                                                                                                        -
                                                                                                        name: string
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        returns
                                                                                                        -

                                                                                                        The name of the connection (i.e. the caption).

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        serverURI

                                                                                                        -
                                                                                                        serverURI: string | undefined
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        returns
                                                                                                        -

                                                                                                        The URI to which the connection is pointing, if applicable. - If a data source is a published data source, the URI is returned - as localhost.

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        type

                                                                                                        -
                                                                                                        type: string
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        returns
                                                                                                        -

                                                                                                        The type of the connection (i.e. SQL Server, web data connector).

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Legend

                                                                                                        -
                                                                                                        -
                                                                                                          -
                                                                                                        • Module
                                                                                                          • -
                                                                                                        • Object literal
                                                                                                          • -
                                                                                                        • Variable
                                                                                                          • -
                                                                                                        • Function
                                                                                                          • -
                                                                                                        • Function with type parameter
                                                                                                          • -
                                                                                                        • Index signature
                                                                                                          • -
                                                                                                        • Type alias
                                                                                                          • -
                                                                                                        • Type alias with type parameter
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Enumeration
                                                                                                          • -
                                                                                                        • Enumeration member
                                                                                                          • -
                                                                                                        • Property
                                                                                                          • -
                                                                                                        • Method
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Interface
                                                                                                          • -
                                                                                                        • Interface with type parameter
                                                                                                          • -
                                                                                                        • Constructor
                                                                                                          • -
                                                                                                        • Property
                                                                                                          • -
                                                                                                        • Method
                                                                                                          • -
                                                                                                        • Index signature
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Class
                                                                                                          • -
                                                                                                        • Class with type parameter
                                                                                                          • -
                                                                                                        • Constructor
                                                                                                          • -
                                                                                                        • Property
                                                                                                          • -
                                                                                                        • Method
                                                                                                          • -
                                                                                                        • Accessor
                                                                                                          • -
                                                                                                        • Index signature
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Inherited constructor
                                                                                                          • -
                                                                                                        • Inherited property
                                                                                                          • -
                                                                                                        • Inherited method
                                                                                                          • -
                                                                                                        • Inherited accessor
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Protected property
                                                                                                          • -
                                                                                                        • Protected method
                                                                                                          • -
                                                                                                        • Protected accessor
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Private property
                                                                                                          • -
                                                                                                        • Private method
                                                                                                          • -
                                                                                                        • Private accessor
                                                                                                          • -
                                                                                                        -
                                                                                                          -
                                                                                                        • Static property
                                                                                                          • -
                                                                                                        • Static method
                                                                                                          • -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - - - - \ No newline at end of file +ConnectionSummary | Tableau Extensions API
                                                                                                        Tableau Extensions API
                                                                                                          Preparing search index...

                                                                                                          Interface ConnectionSummary

                                                                                                          Represents a connection within a datasource (ex: A SQL Server connection). +A data source can be composed of one or more connections.

                                                                                                          +
                                                                                                          interface ConnectionSummary {
                                                                                                              id: string;
                                                                                                              name: string;
                                                                                                              serverURI: undefined | string;
                                                                                                              type: string;
                                                                                                          }
                                                                                                          Index

                                                                                                          Properties

                                                                                                          id +name +serverURI +type +

                                                                                                          Properties

                                                                                                          id: string

                                                                                                          Unique string representing this connection.

                                                                                                          +
                                                                                                          name: string

                                                                                                          The name of the connection (i.e. the caption).

                                                                                                          +
                                                                                                          serverURI: undefined | string

                                                                                                          The URI to which the connection is pointing, if applicable. +If a data source is a published data source, the URI is returned +as localhost.

                                                                                                          +
                                                                                                          type: string

                                                                                                          The type of the connection (i.e. SQL Server, web data connector).

                                                                                                          +

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Properties
                                                                                                          diff --git a/website/static/api/interfaces/dashboard.html b/website/static/api/interfaces/dashboard.html index 6c474436..f8e7df15 100644 --- a/website/static/api/interfaces/dashboard.html +++ b/website/static/api/interfaces/dashboard.html @@ -1,908 +1,172 @@ - - - - - - Dashboard | Tableau Extensions - - - - - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -
                                                                                                          -
                                                                                                          - Options -
                                                                                                          -
                                                                                                          - All -
                                                                                                            -
                                                                                                          • Public
                                                                                                            • -
                                                                                                          • Public/Protected
                                                                                                            • -
                                                                                                          • All
                                                                                                            • -
                                                                                                          -
                                                                                                          - - - - -
                                                                                                          -
                                                                                                          - Menu -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          Interface Dashboard

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          The Dashboard interface inherits from the Sheet interface.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Hierarchy

                                                                                                          -
                                                                                                            -
                                                                                                          • - Sheet -
                                                                                                              -
                                                                                                            • - Dashboard -
                                                                                                              • -
                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Index

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Properties

                                                                                                          - -
                                                                                                          -
                                                                                                          -

                                                                                                          Methods

                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Properties

                                                                                                          -
                                                                                                          - -

                                                                                                          activeDashboardName

                                                                                                          -
                                                                                                          activeDashboardName: string
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The name of the active dashboard.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          activeDashboardObjectId

                                                                                                          -
                                                                                                          activeDashboardObjectId: number
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The ID of the active object in the dashboard.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          name

                                                                                                          -
                                                                                                          name: string
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The name of the sheet.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          objects

                                                                                                          -
                                                                                                          objects: Array<DashboardObject>
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The collection of objects contained in the dashboard.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          sheetType

                                                                                                          -
                                                                                                          sheetType: SheetType
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The type of the sheet.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          size

                                                                                                          -
                                                                                                          size: Size
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          Size of the sheet.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          worksheets

                                                                                                          -
                                                                                                          worksheets: Array<Worksheet>
                                                                                                          - -
                                                                                                          -
                                                                                                          -

                                                                                                          This is a helper method and is equivalent to looping - through all of the objects in a dashboard and collecting all of the objects - whose type is worksheet. You can use this property to iterate - through all of the worksheets in the dashboard.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          returns
                                                                                                          -

                                                                                                          The collection of worksheets contained in the dashboard.

                                                                                                          -

                                                                                                          The following example uses the JavaScript forEach() method to traverse - the worksheets in the dashboard. -

                                                                                                          - 
                                                                                                             let dashboard = tableau.extensions.dashboardContent.dashboard;
-   dashboard.worksheets.forEach(function (worksheet) {
-    // do something with the worksheets..
-      console.log("The worksheet name is " + worksheet.name)
-    });
-
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Methods

                                                                                                          -
                                                                                                          - -

                                                                                                          addEventListener

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Adds a new event listener to the object. If this object does not support the specified eventType, - the method throws an exception. - The following table shows the event types supported by objects.

                                                                                                            -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            objecteventType
                                                                                                            WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                            ParameterParameterChanged
                                                                                                            SettingsSettingsChanged
                                                                                                            DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            -
                                                                                                              -
                                                                                                            • -
                                                                                                              eventType: TableauEventType
                                                                                                              -
                                                                                                              -

                                                                                                              The type of event to register for. The type of event is a TableauEventType enumeration.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            • -
                                                                                                              handler: TableauEventHandlerFn
                                                                                                              -
                                                                                                              -

                                                                                                              The function which will be called when an event happens.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            -

                                                                                                            Returns TableauEventUnregisterFn

                                                                                                            -

                                                                                                            A helper function which can be called to remove this registration.

                                                                                                            -

                                                                                                            The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged). - When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers - the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.

                                                                                                            - 
                                                                                                            // Add an event listener for the selection changed event on this sheet.
-// Assigning the event to a variable just to make the example fit on the page here.
-const markSelection = tableau.TableauEventType.MarkSelectionChanged;
-//
-unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
-// When the selection changes, reload the data
-loadSelectedMarks(worksheetName);
-});
-
-// remove the event listener when done
- unregisterEventHandlerFunction();
-
                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          applyFilterAsync

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Applies a simple categorical filter (non-date) to the dashboard. - This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field. - Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source.

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.9.0 and Tableau 2022.2

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            -
                                                                                                              -
                                                                                                            • -
                                                                                                              fieldName: string
                                                                                                              -
                                                                                                              -

                                                                                                              The name of the field to filter on.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            • -
                                                                                                              values: Array<string>
                                                                                                              -
                                                                                                              -

                                                                                                              The list of values to filter on.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            • -
                                                                                                              updateType: FilterUpdateType
                                                                                                              -
                                                                                                              -

                                                                                                              The update type of this filter (add, all, remove, replace).

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            • -
                                                                                                              filterOptions: FilterOptions
                                                                                                              -
                                                                                                              -

                                                                                                              Advanced filter options (isExcludeMode).

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            -

                                                                                                            Returns Promise<string>

                                                                                                            -

                                                                                                            The field name that the filter is applied on.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          findParameterAsync

                                                                                                          -
                                                                                                            -
                                                                                                          • findParameterAsync(parameterName: string): Promise<Parameter | undefined>
                                                                                                            • -
                                                                                                          -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Searches for a parameter with the given name.

                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            -
                                                                                                              -
                                                                                                            • -
                                                                                                              parameterName: string
                                                                                                              -
                                                                                                              -

                                                                                                              The name of the parameter to find.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            -

                                                                                                            Returns Promise<Parameter | undefined>

                                                                                                            -

                                                                                                            The parameter with the given name, or undefined if it does not exist.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          getDashboardObjectById

                                                                                                          -
                                                                                                            -
                                                                                                          • getDashboardObjectById(dashboardObjectId: number): DashboardObject | undefined
                                                                                                            • -
                                                                                                          -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Gets the specified dashboard object by its id. If a dashboard object is not found this method returns undefined.

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.7.0 and Tableau 2021.4

                                                                                                            -

                                                                                                            The following example shows how you can get a dashboard object using its id. -

                                                                                                            - 
                                                                                                              var dashboard = tableau.extensions.dashboardContent.dashboard;
-  var myDashboardObject = dashboard.getDashboardObjectById(8);
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            -
                                                                                                              -
                                                                                                            • -
                                                                                                              dashboardObjectId: number
                                                                                                              -
                                                                                                              -

                                                                                                              The id of an object on the dashboard.

                                                                                                              -
                                                                                                              -
                                                                                                              • -
                                                                                                            -

                                                                                                            Returns DashboardObject | undefined

                                                                                                            -

                                                                                                            The dashboard object with that id. Returns undefined if the dashboard object is not found.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          getFiltersAsync

                                                                                                          -
                                                                                                            -
                                                                                                          • getFiltersAsync(): Promise<Array<Filter>>
                                                                                                            • -
                                                                                                          -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.9.0 and Tableau 2022.2

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Returns Promise<Array<Filter>>

                                                                                                            -

                                                                                                            The collection of filters used on the dashboard

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          getParametersAsync

                                                                                                          -
                                                                                                            -
                                                                                                          • getParametersAsync(): Promise<Array<Parameter>>
                                                                                                            • -
                                                                                                          -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Returns Promise<Array<Parameter>>

                                                                                                            -

                                                                                                            A collection of all the Tableau parameters that are used in this workbook.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          moveAndResizeDashboardObjectsAsync

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Sets the position and size of one or more floating dashboard objects. - Throws an error if the dashboard object is invalid

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.7.0 and Tableau 2021.4

                                                                                                            -

                                                                                                            The following example shows how you can update the position and size of multiple (valid, floating) dashboard objects in a dashboard -

                                                                                                            - 
                                                                                                              let dashboardObjectPositionAndSizeUpdateArray = [];
-  let dashboardObjectPositionAndSizeUpdate1 = {
-    dashboardObjectID: 1,
-    x: 0,
-    y: 0,
-    width: 50,
-    height: 50
-  };
-  let dashboardObjectPositionAndSizeUpdate2 = {
-    dashboardObjectID: 2,
-    x: 75,
-    y: 75,
-    width: 60,
-    height: 60
-  };
-  dashboardObjectPositionAndSizeUpdateArray.push(dashboardObjectPositionAndSizeUpdate1, dashboardObjectPositionAndsizeUpdate2);
-  tableau.extensions.dashboardContent.dashboard.moveAndResizeDashboardObjectsAsync(dashboardObjectPositionAndSizeUpdateArray)
-  .then(() => {
-    console.log("done");
-  });
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            - -

                                                                                                            Returns Promise<void>

                                                                                                            -

                                                                                                            Empty promise that resolves when the position and size of the dashboard objects have been changed.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          removeEventListener

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function - returned from the call to addEventListener to unregister the event listener. - For more information, see Events and Event Handling.

                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            - -

                                                                                                            Returns boolean

                                                                                                            -

                                                                                                            Whether or not an event listener was removed.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          replayAnimationAsync

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Replays an animation for the active sheet - Throws an error if the replay speed is invalid

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.7.0 and Tableau 2021.4

                                                                                                            -

                                                                                                            The following example shows how you can replay an animation in a dashboard. -

                                                                                                            - 
                                                                                                              let replaySpeed = tableau.ReplaySpeedType.Normal;
-  tableau.extensions.dashboardContent.dashboard.replayAnimationAsync(replaySpeed).then(() => {
-    console.log("done");
-  });
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Parameters

                                                                                                            - -

                                                                                                            Returns Promise<void>

                                                                                                            -

                                                                                                            Empty promise that resolves when the animation has been replayed.

                                                                                                            -
                                                                                                            • -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          setDashboardObjectVisibilityAsync

                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            Sets the visibility of one or more dashboard objects. - Throws an error if the dashboard object is invalid

                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            since
                                                                                                            -

                                                                                                            1.7.0 and Tableau 2021.4

                                                                                                            -

                                                                                                            The following example shows how you can update the visibility of multiple valid dashboard objects -

                                                                                                            - 
                                                                                                              var dashboardObjectVisibilityMap = new Map();
-  dashboardObjectVisibilityMap.set(10, tableau.DashboardObjectVisibilityType.Show);
-  dashboardObjectVisibilityMap.set(8, tableau.DashboardObjectVisibilityType.Hide);
-  var dashboard = tableau.extensions.dashboardContent.dashboard;
-  dashboard.setDashboardObjectVisibilityAsync(dashboardObjectVisibilityMap).then(() => {
-    console.log("done");
+
-
-Dashboard | Tableau Extensions API
                                                                                                            Tableau Extensions API
                                                                                                              Preparing search index...
                                                                                                              Interface Dashboard
                                                                                                              The Dashboard interface inherits from the Sheet interface.
                                                                                                              
+
                                                                                                              interface Dashboard {
                                                                                                                  activeDashboardName: string;
                                                                                                                  activeDashboardObjectId: number;
                                                                                                                  name: string;
                                                                                                                  objects: DashboardObject[];
                                                                                                                  sheetType: SheetType;
                                                                                                                  size: Size;
                                                                                                                  worksheets: Worksheet[];
                                                                                                                  addEventListener(
                                                                                                                      eventType: TableauEventType,
                                                                                                                      handler: TableauEventHandlerFn,
                                                                                                                  ): TableauEventUnregisterFn;
                                                                                                                  applyFilterAsync(
                                                                                                                      fieldName: string,
                                                                                                                      values: string[],
                                                                                                                      updateType: FilterUpdateType,
                                                                                                                      filterOptions: FilterOptions,
                                                                                                                  ): Promise<string>;
                                                                                                                  findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
                                                                                                                  getDashboardObjectById(
                                                                                                                      dashboardObjectId: number,
                                                                                                                  ): undefined | DashboardObject;
                                                                                                                  getFiltersAsync(): Promise<Filter[]>;
                                                                                                                  getParametersAsync(): Promise<Parameter[]>;
                                                                                                                  moveAndResizeDashboardObjectsAsync(
                                                                                                                      dashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdateArray,
                                                                                                                  ): Promise<void>;
                                                                                                                  removeEventListener(
                                                                                                                      eventType: TableauEventType,
                                                                                                                      handler: TableauEventHandlerFn,
                                                                                                                  ): boolean;
                                                                                                                  replayAnimationAsync(replaySpeed: ReplaySpeedType): Promise<void>;
                                                                                                                  setDashboardObjectVisibilityAsync(
                                                                                                                      dashboardObjectVisibilityMap: DashboardObjectVisibilityMap,
                                                                                                                  ): Promise<void>;
                                                                                                                  setZoneVisibilityAsync(zoneVisibilityMap: ZoneVisibilityMap): Promise<void>;
                                                                                                              }
                                                                                                              Hierarchy (View Summary)
                                                                                                              Index
                                                                                                              Properties
                                                                                                              activeDashboardName
+activeDashboardObjectId
+name
+objects
+sheetType
+size
+worksheets
+
                                                                                                              Methods
                                                                                                              addEventListener
+applyFilterAsync
+findParameterAsync
+getDashboardObjectById
+getFiltersAsync
+getParametersAsync
+moveAndResizeDashboardObjectsAsync
+removeEventListener
+replayAnimationAsync
+setDashboardObjectVisibilityAsync
+setZoneVisibilityAsync
+
                                                                                                              Properties
                                                                                                              activeDashboardName: string
                                                                                                              The name of the active dashboard.
                                                                                                              
+
                                                                                                              activeDashboardObjectId: number
                                                                                                              The ID of the active object in the dashboard.
                                                                                                              
+
                                                                                                              name: string
                                                                                                              The name of the sheet.
                                                                                                              
+
                                                                                                              objects: DashboardObject[]
                                                                                                              The collection of objects contained in the dashboard.
                                                                                                              
+
                                                                                                              sheetType: SheetType
                                                                                                              The type of the sheet.
                                                                                                              
+
                                                                                                              size: Size
                                                                                                              Size of the sheet.
                                                                                                              
+
                                                                                                              worksheets: Worksheet[]
                                                                                                              This is a helper method and is equivalent to looping
+through all of the objects in a dashboard and collecting all of the objects
+whose type is worksheet. You can use this property to iterate
+through all of the worksheets in the dashboard.
                                                                                                              
+
                                                                                                              The collection of worksheets contained in the dashboard.
                                                                                                              
+
                                                                                                              The following example uses the JavaScript forEach() method to traverse
+the worksheets in the dashboard.
+
                                                                                                              
+
                                                                                                                 let dashboard = tableau.extensions.dashboardContent.dashboard;
                                                                                                                 dashboard.worksheets.forEach(function (worksheet) {
                                                                                                                  // do something with the worksheets..
                                                                                                                    console.log("The worksheet name is " + worksheet.name)
                                                                                                                  });
                                                                                                              
+
                                                                                                              
+
+
                                                                                                              Methods
                                                                                                              • Adds a new event listener to the object. If this object does not support the specified eventType,
+the method throws an exception.
+The following table shows the event types supported by objects.
                                                                                                                
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                objecteventType
                                                                                                                WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                ParameterParameterChanged
                                                                                                                SettingsSettingsChanged
                                                                                                                DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                • eventType: TableauEventType
                                                                                                                  The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                  
+
                                                                                                                • handler: TableauEventHandlerFn
                                                                                                                  The function which will be called when an event happens.
                                                                                                                  
+
                                                                                                                Returns TableauEventUnregisterFn
                                                                                                                A helper function which can be called to remove this registration.
                                                                                                                
+
                                                                                                                The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
+When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
+the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                
+
                                                                                                                // Add an event listener for the selection changed event on this sheet.
                                                                                                                // Assigning the event to a variable just to make the example fit on the page here.
                                                                                                                 const markSelection = tableau.TableauEventType.MarkSelectionChanged;
                                                                                                                  //
                                                                                                                 unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
                                                                                                                 // When the selection changes, reload the data
                                                                                                                     loadSelectedMarks(worksheetName);
                                                                                                                 });

                                                                                                                // remove the event listener when done
                                                                                                                 unregisterEventHandlerFunction();
                                                                                                                
+
                                                                                                                
+
+
                                                                                                              • Applies a simple categorical filter (non-date) to the dashboard.
+This method is similar to the method used for worksheets, but applies the filter to all the worksheets in the dashboard that have that same field.
+Note that the filter is ignored by a worksheet if the worksheet doesn't have the relevant field in its data source.
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                • fieldName: string
                                                                                                                  The name of the field to filter on.
                                                                                                                  
+
                                                                                                                • values: string[]
                                                                                                                  The list of values to filter on.
                                                                                                                  
+
                                                                                                                • updateType: FilterUpdateType
                                                                                                                  The update type of this filter (add, all, remove, replace).
                                                                                                                  
+
                                                                                                                • filterOptions: FilterOptions
                                                                                                                  Advanced filter options (isExcludeMode).
                                                                                                                  
+
                                                                                                                Returns Promise<string>
                                                                                                                The field name that the filter is applied on.
                                                                                                                
+
                                                                                                                1.9.0 and Tableau 2022.2
                                                                                                                
+
                                                                                                              • Searches for a parameter with the given name.
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                • parameterName: string
                                                                                                                  The name of the parameter to find.
                                                                                                                  
+
                                                                                                                Returns Promise<undefined | Parameter>
                                                                                                                The parameter with the given name, or undefined if it does not exist.
                                                                                                                
+
                                                                                                              • Gets the specified dashboard object by its id. If a dashboard object is not found this method returns undefined.
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                • dashboardObjectId: number
                                                                                                                  The id of an object on the dashboard.
                                                                                                                  
+
                                                                                                                Returns undefined | DashboardObject
                                                                                                                The dashboard object with that id. Returns undefined if the dashboard object is not found.
                                                                                                                
+
                                                                                                                1.7.0 and Tableau 2021.4
                                                                                                                
+
                                                                                                                The following example shows how you can get a dashboard object using its id.
+
                                                                                                                
+
                                                                                                                  var dashboard = tableau.extensions.dashboardContent.dashboard;
                                                                                                                  var myDashboardObject = dashboard.getDashboardObjectById(8);
+
                                                                                                                
+
+
                                                                                                              • Returns Promise<Filter[]>
                                                                                                                The collection of filters used on the dashboard
                                                                                                                
+
                                                                                                                1.9.0 and Tableau 2022.2
                                                                                                                
+
                                                                                                              • Returns Promise<Parameter[]>
                                                                                                                A collection of all the Tableau parameters that are used in this workbook.
                                                                                                                
+
                                                                                                              • Sets the position and size of one or more floating dashboard objects.
+Throws an error if the dashboard object is invalid
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                Returns Promise<void>
                                                                                                                Empty promise that resolves when the position and size of the dashboard objects have been changed.
                                                                                                                
+
                                                                                                                1.7.0 and Tableau 2021.4
                                                                                                                
+
                                                                                                                The following example shows how you can update the position and size of multiple (valid, floating) dashboard objects in a dashboard
+
                                                                                                                
+
                                                                                                                  let dashboardObjectPositionAndSizeUpdateArray = [];
                                                                                                                  let dashboardObjectPositionAndSizeUpdate1 = {
                                                                                                                    dashboardObjectID: 1,
                                                                                                                    x: 0,
                                                                                                                    y: 0,
                                                                                                                    width: 50,
                                                                                                                    height: 50
                                                                                                                  };
                                                                                                                  let dashboardObjectPositionAndSizeUpdate2 = {
                                                                                                                    dashboardObjectID: 2,
                                                                                                                    x: 75,
                                                                                                                    y: 75,
                                                                                                                    width: 60,
                                                                                                                    height: 60
                                                                                                                  };
                                                                                                                  dashboardObjectPositionAndSizeUpdateArray.push(dashboardObjectPositionAndSizeUpdate1, dashboardObjectPositionAndsizeUpdate2);
                                                                                                                  tableau.extensions.dashboardContent.dashboard.moveAndResizeDashboardObjectsAsync(dashboardObjectPositionAndSizeUpdateArray)
                                                                                                                  .then(() => {
                                                                                                                    console.log("done");
                                                                                                                
+
                                                                                                                
+
+
                                                                                                              • Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
+The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function
+returned from the call to addEventListener to unregister the event listener.
+For more information, see Events and Event Handling.
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                Returns boolean
                                                                                                                Whether or not an event listener was removed.
                                                                                                                
+
                                                                                                              • Replays an animation for the active sheet
+Throws an error if the replay speed is invalid
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                Returns Promise<void>
                                                                                                                Empty promise that resolves when the animation has been replayed.
                                                                                                                
+
                                                                                                                1.7.0 and Tableau 2021.4
                                                                                                                
+
                                                                                                                The following example shows how you can replay an animation in a dashboard.
+
                                                                                                                
+
                                                                                                                  let replaySpeed = tableau.ReplaySpeedType.Normal;
                                                                                                                  tableau.extensions.dashboardContent.dashboard.replayAnimationAsync(replaySpeed).then(() => {
                                                                                                                    console.log("done");
                                                                                                                
+
                                                                                                                
+
+
                                                                                                              • Sets the visibility of one or more dashboard objects.
+Throws an error if the dashboard object is invalid
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                Returns Promise<void>
                                                                                                                Empty promise that resolves when the visibility has been changed.
                                                                                                                
+
                                                                                                                1.7.0 and Tableau 2021.4
                                                                                                                
+
                                                                                                                The following example shows how you can update the visibility of multiple valid dashboard objects
+
                                                                                                                
+
                                                                                                                  var dashboardObjectVisibilityMap = new Map();
                                                                                                                  dashboardObjectVisibilityMap.set(10, tableau.DashboardObjectVisibilityType.Show);
                                                                                                                  dashboardObjectVisibilityMap.set(8, tableau.DashboardObjectVisibilityType.Hide);
                                                                                                                  var dashboard = tableau.extensions.dashboardContent.dashboard;
                                                                                                                  dashboard.setDashboardObjectVisibilityAsync(dashboardObjectVisibilityMap).then(() => {
                                                                                                                    console.log("done");
                                                                                                                  });
                                                                                                                
+
                                                                                                                
+
+
                                                                                                              • Sets the visibility of one or more floating dashboard zones.
+Throws an error if the zone is invalid
                                                                                                                
+
                                                                                                                Parameters
                                                                                                                • zoneVisibilityMap: ZoneVisibilityMap
                                                                                                                  A map of zone ids to the desired state of visibility for that zone.
                                                                                                                  
+
                                                                                                                Returns Promise<void>
                                                                                                                Empty promise that resolves when the visibility has been changed.
                                                                                                                
+
                                                                                                                1.1.0
                                                                                                                
+
                                                                                                                use setDashboardObjectVisibilityAsync
                                                                                                                
+
                                                                                                                The following example shows how you can update the visibility of multiple (valid, floating) zones in a dashboard
+
                                                                                                                
+
                                                                                                                  var zoneVisibilityMap = {};
                                                                                                                  zoneVisibilityMap[10] =  tableau.ZoneVisibilityType.Show;
                                                                                                                  zoneVisibilityMap[8] =  tableau.ZoneVisibilityType.Hide;
                                                                                                                  tableau.extensions.dashboardContent.dashboard.setZoneVisibilityAsync(zoneVisibilityMap).then(() => {
                                                                                                                    console.log("done");
                                                                                                                  });
                                                                                                                
+
                                                                                                                
+
+
                                                                                                                1.4.0 The zoneVisibilityMap can be either an untyped object, or a Map.
                                                                                                                
+
                                                                                                                  var zoneVisibilityMap = new Map;
                                                                                                                  zoneVisibilityMap.set(10, tableau.ZoneVisibilityType.Show);
                                                                                                                  zoneVisibilityMap.set(8, tableau.ZoneVisibilityType.Hide);
+
                                                                                                                
 
-        ga('create', '469571326', 'auto');
-        ga('send', 'pageview');
-    
-
-
\ No newline at end of file
+
                                                                                                                1.5.0 The zone can be any zone in the dashboard.
                                                                                                                
+
                                                                                                              Settings
                                                                                                              Member Visibility
                                                                                                              On This Page
                                                                                                              Properties
                                                                                                              Methods
                                                                                                              
diff --git a/website/static/api/interfaces/dashboardcontent.html b/website/static/api/interfaces/dashboardcontent.html
index aa8c98f2..241367e6 100644
--- a/website/static/api/interfaces/dashboardcontent.html
+++ b/website/static/api/interfaces/dashboardcontent.html
@@ -1,219 +1,31 @@
-
-
-
-	
-	
-	DashboardContent | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                              
-	
                                                                                                              
-		
                                                                                                              
-			
                                                                                                              
-				
-				
                                                                                                              
-					
                                                                                                              
-						Options
-						
                                                                                                              
-							
                                                                                                              
-								All
-								
                                                                                                                
-									
                                                                                                              • Public
                                                                                                                • 
-									
                                                                                                              • Public/Protected
                                                                                                                • 
-									
                                                                                                              • All
                                                                                                                • 
-								
                                                                                                              
-							
                                                                                                              
-							
-							
-							
-							
-						
                                                                                                              
-					
                                                                                                              
-					Menu
-				
                                                                                                              
-			
                                                                                                              
-		
                                                                                                              
-	
                                                                                                              
-	
                                                                                                              
-		
                                                                                                              
-			
-			
                                                                                                              Interface DashboardContent
                                                                                                              
-		
                                                                                                              
-	
                                                                                                              
-
                                                                                                              
-
                                                                                                              
-	
                                                                                                              
-		
                                                                                                              
-			
                                                                                                              
-				
                                                                                                              
-					
                                                                                                              
-						
                                                                                                              The DashboardContent namespace is the namespace associated with Dashboard Extensions.
-							The DashboardContent namespace contains the Dashboard interface. Use the Dashboard Interface to
-						access dashboard objects, worksheets, and parameters, and to add or remove event listeners.
                                                                                                              
-					
                                                                                                              
-				
                                                                                                              
-			
                                                                                                              
-			
                                                                                                              
-				
                                                                                                              Hierarchy
                                                                                                              
-				
                                                                                                                
-					
                                                                                                              • 
-						DashboardContent
-					
                                                                                                                • 
-				
                                                                                                              
-			
                                                                                                              
-			
                                                                                                              
-				
                                                                                                              Index
                                                                                                              
-				
                                                                                                              
-					
                                                                                                              
-						
                                                                                                              
-							
                                                                                                              Properties
                                                                                                              
-							
-						
                                                                                                              
-					
                                                                                                              
-				
                                                                                                              
-			
                                                                                                              
-			
                                                                                                              
-				
                                                                                                              Properties
                                                                                                              
-				
                                                                                                              
-					
-					
                                                                                                              dashboard
                                                                                                              
-					
                                                                                                              dashboard: Dashboard
                                                                                                              
-					
-					
                                                                                                              
-						
                                                                                                              
-							
                                                                                                              returns
                                                                                                              
-							
                                                                                                              The dashboard object representing the Tableau
-								dashboard where the extension is running.
                                                                                                              
-							
                                                                                                              
-						
                                                                                                              
-					
                                                                                                              
-				
                                                                                                              
-			
                                                                                                              
-		
                                                                                                              
-		
                                                                                                              
-			
-			
-		
                                                                                                              
-	
                                                                                                              
-
                                                                                                              
-
                                                                                                              
-	
                                                                                                              
-		
                                                                                                              Legend
                                                                                                              
-		
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Module
                                                                                                                • 
-				
                                                                                                              • Object literal
                                                                                                                • 
-				
                                                                                                              • Variable
                                                                                                                • 
-				
                                                                                                              • Function
                                                                                                                • 
-				
                                                                                                              • Function with type parameter
                                                                                                                • 
-				
                                                                                                              • Index signature
                                                                                                                • 
-				
                                                                                                              • Type alias
                                                                                                                • 
-				
                                                                                                              • Type alias with type parameter
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Enumeration
                                                                                                                • 
-				
                                                                                                              • Enumeration member
                                                                                                                • 
-				
                                                                                                              • Property
                                                                                                                • 
-				
                                                                                                              • Method
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Interface
                                                                                                                • 
-				
                                                                                                              • Interface with type parameter
                                                                                                                • 
-				
                                                                                                              • Constructor
                                                                                                                • 
-				
                                                                                                              • Property
                                                                                                                • 
-				
                                                                                                              • Method
                                                                                                                • 
-				
                                                                                                              • Index signature
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Class
                                                                                                                • 
-				
                                                                                                              • Class with type parameter
                                                                                                                • 
-				
                                                                                                              • Constructor
                                                                                                                • 
-				
                                                                                                              • Property
                                                                                                                • 
-				
                                                                                                              • Method
                                                                                                                • 
-				
                                                                                                              • Accessor
                                                                                                                • 
-				
                                                                                                              • Index signature
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Inherited constructor
                                                                                                                • 
-				
                                                                                                              • Inherited property
                                                                                                                • 
-				
                                                                                                              • Inherited method
                                                                                                                • 
-				
                                                                                                              • Inherited accessor
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Protected property
                                                                                                                • 
-				
                                                                                                              • Protected method
                                                                                                                • 
-				
                                                                                                              • Protected accessor
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Private property
                                                                                                                • 
-				
                                                                                                              • Private method
                                                                                                                • 
-				
                                                                                                              • Private accessor
                                                                                                                • 
-			
                                                                                                              
-			
                                                                                                                
-				
                                                                                                              • Static property
                                                                                                                • 
-				
                                                                                                              • Static method
                                                                                                                • 
-			
                                                                                                              
-		
                                                                                                              
-	
                                                                                                              
-
                                                                                                              
-
                                                                                                              
-
-
-
-
-
\ No newline at end of file
+DashboardContent | Tableau Extensions API
                                                                                                              Tableau Extensions API
                                                                                                                Preparing search index...
                                                                                                                Interface DashboardContent
                                                                                                                The DashboardContent namespace is the namespace associated with Dashboard Extensions.
+The DashboardContent namespace contains the Dashboard interface. Use the Dashboard Interface to
+access dashboard objects, worksheets, and parameters, and to add or remove event listeners.
                                                                                                                
+
                                                                                                                interface DashboardContent {
                                                                                                                    dashboard: Dashboard;
                                                                                                                }
                                                                                                                Index
                                                                                                                Properties
                                                                                                                dashboard
+
                                                                                                                Properties
                                                                                                                dashboard: Dashboard
                                                                                                                The dashboard object representing the Tableau
+dashboard where the extension is running.
                                                                                                                
+
                                                                                                                Settings
                                                                                                                Member Visibility
                                                                                                                On This Page
                                                                                                                Properties
                                                                                                                
diff --git a/website/static/api/interfaces/dashboardlayoutchangedevent.html b/website/static/api/interfaces/dashboardlayoutchangedevent.html
index d8f34227..218f1b78 100644
--- a/website/static/api/interfaces/dashboardlayoutchangedevent.html
+++ b/website/static/api/interfaces/dashboardlayoutchangedevent.html
@@ -1,249 +1,32 @@
-
-
-
-	
-	
-	DashboardLayoutChangedEvent | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                
-	
                                                                                                                
-		
                                                                                                                
-			
                                                                                                                
-				
-				
                                                                                                                
-					
                                                                                                                
-						Options
-						
                                                                                                                
-							
                                                                                                                
-								All
-								
                                                                                                                  
-									
                                                                                                                • Public
                                                                                                                  • 
-									
                                                                                                                • Public/Protected
                                                                                                                  • 
-									
                                                                                                                • All
                                                                                                                  • 
-								
                                                                                                                
-							
                                                                                                                
-							
-							
-							
-							
-						
                                                                                                                
-					
                                                                                                                
-					Menu
-				
                                                                                                                
-			
                                                                                                                
-		
                                                                                                                
-	
                                                                                                                
-	
                                                                                                                
-		
                                                                                                                
-			
-			
                                                                                                                Interface DashboardLayoutChangedEvent
                                                                                                                
-		
                                                                                                                
-	
                                                                                                                
-
                                                                                                                
-
                                                                                                                
-	
                                                                                                                
-		
                                                                                                                
-			
                                                                                                                
-				
                                                                                                                
-					
                                                                                                                
-						
                                                                                                                An event which is raised when the dashboard objects are modified.
-						Should be listened for directly from the tableau.extensions.dashboardContent.dashboard object.
                                                                                                                
-					
                                                                                                                
-					
                                                                                                                
-						
                                                                                                                since
                                                                                                                
-						
                                                                                                                1.7.0 and Tableau 2021.4
                                                                                                                
-						
                                                                                                                
-					
                                                                                                                
-				
                                                                                                                
-			
                                                                                                                
-			
                                                                                                                
-				
                                                                                                                Hierarchy
                                                                                                                
-				
                                                                                                                  
-					
                                                                                                                • 
-						TableauEvent
-						
                                                                                                                    
-							
                                                                                                                  • 
-								DashboardLayoutChangedEvent
-							
                                                                                                                    • 
-						
                                                                                                                  
-					
                                                                                                                  • 
-				
                                                                                                                
-			
                                                                                                                
-			
                                                                                                                
-				
                                                                                                                Index
                                                                                                                
-				
                                                                                                                
-					
                                                                                                                
-						
                                                                                                                
-							
                                                                                                                Properties
                                                                                                                
-							
-						
                                                                                                                
-					
                                                                                                                
-				
                                                                                                                
-			
                                                                                                                
-			
                                                                                                                
-				
                                                                                                                Properties
                                                                                                                
-				
                                                                                                                
-					
-					
                                                                                                                dashboardLayoutChangeDetails
                                                                                                                
-					
                                                                                                                dashboardLayoutChangeDetails: DashboardLayoutChangeDetails
                                                                                                                
-					
-					
                                                                                                                
-						
                                                                                                                
-							
                                                                                                                returns
                                                                                                                
-							
                                                                                                                a map of dashboard object id's to an array of dashboard object layout changes
                                                                                                                
-							
                                                                                                                
-						
                                                                                                                
-					
                                                                                                                
-				
                                                                                                                
-				
                                                                                                                
-					
-					
                                                                                                                type
                                                                                                                
-					
                                                                                                                type: TableauEventType
                                                                                                                
-					
-					
                                                                                                                
-						
                                                                                                                
-							
                                                                                                                returns
                                                                                                                
-							
                                                                                                                The type of event which this class is representing.
                                                                                                                
-							
                                                                                                                
-						
                                                                                                                
-					
                                                                                                                
-				
                                                                                                                
-			
                                                                                                                
-		
                                                                                                                
-		
                                                                                                                
-			
-			
-		
                                                                                                                
-	
                                                                                                                
-
                                                                                                                
-
                                                                                                                
-	
                                                                                                                
-		
                                                                                                                Legend
                                                                                                                
-		
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Module
                                                                                                                  • 
-				
                                                                                                                • Object literal
                                                                                                                  • 
-				
                                                                                                                • Variable
                                                                                                                  • 
-				
                                                                                                                • Function
                                                                                                                  • 
-				
                                                                                                                • Function with type parameter
                                                                                                                  • 
-				
                                                                                                                • Index signature
                                                                                                                  • 
-				
                                                                                                                • Type alias
                                                                                                                  • 
-				
                                                                                                                • Type alias with type parameter
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Enumeration
                                                                                                                  • 
-				
                                                                                                                • Enumeration member
                                                                                                                  • 
-				
                                                                                                                • Property
                                                                                                                  • 
-				
                                                                                                                • Method
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Interface
                                                                                                                  • 
-				
                                                                                                                • Interface with type parameter
                                                                                                                  • 
-				
                                                                                                                • Constructor
                                                                                                                  • 
-				
                                                                                                                • Property
                                                                                                                  • 
-				
                                                                                                                • Method
                                                                                                                  • 
-				
                                                                                                                • Index signature
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Class
                                                                                                                  • 
-				
                                                                                                                • Class with type parameter
                                                                                                                  • 
-				
                                                                                                                • Constructor
                                                                                                                  • 
-				
                                                                                                                • Property
                                                                                                                  • 
-				
                                                                                                                • Method
                                                                                                                  • 
-				
                                                                                                                • Accessor
                                                                                                                  • 
-				
                                                                                                                • Index signature
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Inherited constructor
                                                                                                                  • 
-				
                                                                                                                • Inherited property
                                                                                                                  • 
-				
                                                                                                                • Inherited method
                                                                                                                  • 
-				
                                                                                                                • Inherited accessor
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Protected property
                                                                                                                  • 
-				
                                                                                                                • Protected method
                                                                                                                  • 
-				
                                                                                                                • Protected accessor
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Private property
                                                                                                                  • 
-				
                                                                                                                • Private method
                                                                                                                  • 
-				
                                                                                                                • Private accessor
                                                                                                                  • 
-			
                                                                                                                
-			
                                                                                                                  
-				
                                                                                                                • Static property
                                                                                                                  • 
-				
                                                                                                                • Static method
                                                                                                                  • 
-			
                                                                                                                
-		
                                                                                                                
-	
                                                                                                                
-
                                                                                                                
-
                                                                                                                
-
-
-
-
-
\ No newline at end of file
+DashboardLayoutChangedEvent | Tableau Extensions API
                                                                                                                Tableau Extensions API
                                                                                                                  Preparing search index...
                                                                                                                  Interface DashboardLayoutChangedEvent
                                                                                                                  An event which is raised when the dashboard objects are modified.
+Should be listened for directly from the tableau.extensions.dashboardContent.dashboard object.
                                                                                                                  
+
                                                                                                                  1.7.0 and Tableau 2021.4
                                                                                                                  
+
                                                                                                                  interface DashboardLayoutChangedEvent {
                                                                                                                      dashboardLayoutChangeDetails: DashboardLayoutChangeDetails;
                                                                                                                      type: TableauEventType;
                                                                                                                  }
                                                                                                                  Hierarchy (View Summary)
                                                                                                                  Index
                                                                                                                  Properties
                                                                                                                  dashboardLayoutChangeDetails
+type
+
                                                                                                                  Properties
                                                                                                                  dashboardLayoutChangeDetails: DashboardLayoutChangeDetails
                                                                                                                  a map of dashboard object id's to an array of dashboard object layout changes
                                                                                                                  
+
                                                                                                                  type: TableauEventType
                                                                                                                  The type of event which this class is representing.
                                                                                                                  
+
                                                                                                                  Settings
                                                                                                                  Member Visibility
                                                                                                                  On This Page
                                                                                                                  Properties
                                                                                                                  
diff --git a/website/static/api/interfaces/dashboardobject.html b/website/static/api/interfaces/dashboardobject.html
index 652a6240..c011c432 100644
--- a/website/static/api/interfaces/dashboardobject.html
+++ b/website/static/api/interfaces/dashboardobject.html
@@ -1,417 +1,50 @@
-
-
-
-	
-	
-	DashboardObject | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                  
-	
                                                                                                                  
-		
                                                                                                                  
-			
                                                                                                                  
-				
-				
                                                                                                                  
-					
                                                                                                                  
-						Options
-						
                                                                                                                  
-							
                                                                                                                  
-								All
-								
                                                                                                                    
-									
                                                                                                                  • Public
                                                                                                                    • 
-									
                                                                                                                  • Public/Protected
                                                                                                                    • 
-									
                                                                                                                  • All
                                                                                                                    • 
-								
                                                                                                                  
-							
                                                                                                                  
-							
-							
-							
-							
-						
                                                                                                                  
-					
                                                                                                                  
-					Menu
-				
                                                                                                                  
-			
                                                                                                                  
-		
                                                                                                                  
-	
                                                                                                                  
-	
                                                                                                                  
-		
                                                                                                                  
-			
-			
                                                                                                                  Interface DashboardObject
                                                                                                                  
-		
                                                                                                                  
-	
                                                                                                                  
-
                                                                                                                  
-
                                                                                                                  
-	
                                                                                                                  
-		
                                                                                                                  
-			
                                                                                                                  
-				
                                                                                                                  
-					
                                                                                                                  
-						
                                                                                                                  An object of a dashboard.
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-			
                                                                                                                  
-			
                                                                                                                  
-				
                                                                                                                  Hierarchy
                                                                                                                  
-				
                                                                                                                    
-					
                                                                                                                  • 
-						DashboardObject
-					
                                                                                                                    • 
-				
                                                                                                                  
-			
                                                                                                                  
-			
                                                                                                                  
-				
                                                                                                                  Index
                                                                                                                  
-				
                                                                                                                  
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  Properties
                                                                                                                  
-							
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-			
                                                                                                                  
-			
                                                                                                                  
-				
                                                                                                                  Properties
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  dashboard
                                                                                                                  
-					
                                                                                                                  dashboard: Dashboard
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The Dashboard object that contains this object.
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  fieldId
                                                                                                                  
-					
                                                                                                                  fieldId: string | undefined
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The field id of the dashboard object if it is a QuickFilter
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  id
                                                                                                                  
-					
                                                                                                                  id: number
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The id of the dashboard object
                                                                                                                  
-							
                                                                                                                  
-							
                                                                                                                  since
                                                                                                                  
-							
                                                                                                                  1.1.0
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  isFloating
                                                                                                                  
-					
                                                                                                                  isFloating: boolean
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  True if the object is floating in the dashboard.
                                                                                                                  
-							
                                                                                                                  
-							
                                                                                                                  since
                                                                                                                  
-							
                                                                                                                  1.1.0
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  isVisible
                                                                                                                  
-					
                                                                                                                  isVisible: boolean
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  True if the object is visible.
                                                                                                                  
-							
                                                                                                                  
-							
                                                                                                                  since
                                                                                                                  
-							
                                                                                                                  1.1.0
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  name
                                                                                                                  
-					
                                                                                                                  name: string
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The name of the dashboard object. This is the name given to the object during authoring.
                                                                                                                  
-							
                                                                                                                  
-							
                                                                                                                  since
                                                                                                                  
-							
                                                                                                                  1.1.0
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  position
                                                                                                                  
-					
                                                                                                                  position: Point
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The coordinates relative to the top-left corner of the dashboard containing this object.
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  size
                                                                                                                  
-					
                                                                                                                  size: Size
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  The size of the object.
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  type
                                                                                                                  
-					
                                                                                                                  type: DashboardObjectType
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  What the object represents.
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-				
                                                                                                                  
-					
-					
                                                                                                                  worksheet
                                                                                                                  
-					
                                                                                                                  worksheet: Worksheet | undefined
                                                                                                                  
-					
-					
                                                                                                                  
-						
                                                                                                                  
-							
                                                                                                                  returns
                                                                                                                  
-							
                                                                                                                  If type returns WORKSHEET or QUICKFILTER, this returns a Worksheet object, undefined otherwise.
                                                                                                                  
-							
                                                                                                                  
-						
                                                                                                                  
-					
                                                                                                                  
-				
                                                                                                                  
-			
                                                                                                                  
-		
                                                                                                                  
-		
                                                                                                                  
-			
-			
-		
                                                                                                                  
-	
                                                                                                                  
-
                                                                                                                  
-
                                                                                                                  
-	
                                                                                                                  
-		
                                                                                                                  Legend
                                                                                                                  
-		
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Module
                                                                                                                    • 
-				
                                                                                                                  • Object literal
                                                                                                                    • 
-				
                                                                                                                  • Variable
                                                                                                                    • 
-				
                                                                                                                  • Function
                                                                                                                    • 
-				
                                                                                                                  • Function with type parameter
                                                                                                                    • 
-				
                                                                                                                  • Index signature
                                                                                                                    • 
-				
                                                                                                                  • Type alias
                                                                                                                    • 
-				
                                                                                                                  • Type alias with type parameter
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Enumeration
                                                                                                                    • 
-				
                                                                                                                  • Enumeration member
                                                                                                                    • 
-				
                                                                                                                  • Property
                                                                                                                    • 
-				
                                                                                                                  • Method
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Interface
                                                                                                                    • 
-				
                                                                                                                  • Interface with type parameter
                                                                                                                    • 
-				
                                                                                                                  • Constructor
                                                                                                                    • 
-				
                                                                                                                  • Property
                                                                                                                    • 
-				
                                                                                                                  • Method
                                                                                                                    • 
-				
                                                                                                                  • Index signature
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Class
                                                                                                                    • 
-				
                                                                                                                  • Class with type parameter
                                                                                                                    • 
-				
                                                                                                                  • Constructor
                                                                                                                    • 
-				
                                                                                                                  • Property
                                                                                                                    • 
-				
                                                                                                                  • Method
                                                                                                                    • 
-				
                                                                                                                  • Accessor
                                                                                                                    • 
-				
                                                                                                                  • Index signature
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Inherited constructor
                                                                                                                    • 
-				
                                                                                                                  • Inherited property
                                                                                                                    • 
-				
                                                                                                                  • Inherited method
                                                                                                                    • 
-				
                                                                                                                  • Inherited accessor
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Protected property
                                                                                                                    • 
-				
                                                                                                                  • Protected method
                                                                                                                    • 
-				
                                                                                                                  • Protected accessor
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Private property
                                                                                                                    • 
-				
                                                                                                                  • Private method
                                                                                                                    • 
-				
                                                                                                                  • Private accessor
                                                                                                                    • 
-			
                                                                                                                  
-			
                                                                                                                    
-				
                                                                                                                  • Static property
                                                                                                                    • 
-				
                                                                                                                  • Static method
                                                                                                                    • 
-			
                                                                                                                  
-		
                                                                                                                  
-	
                                                                                                                  
-
                                                                                                                  
-
                                                                                                                  
-
-
-
-
-
\ No newline at end of file
+DashboardObject | Tableau Extensions API
                                                                                                                  Tableau Extensions API
                                                                                                                    Preparing search index...
                                                                                                                    Interface DashboardObject
                                                                                                                    An object of a dashboard.
                                                                                                                    
+
                                                                                                                    interface DashboardObject {
                                                                                                                        dashboard: Dashboard;
                                                                                                                        fieldId: undefined | string;
                                                                                                                        id: number;
                                                                                                                        isFloating: boolean;
                                                                                                                        isVisible: boolean;
                                                                                                                        name: string;
                                                                                                                        position: Point;
                                                                                                                        size: Size;
                                                                                                                        type: DashboardObjectType;
                                                                                                                        worksheet: undefined | Worksheet;
                                                                                                                    }
                                                                                                                    Index
                                                                                                                    Properties
                                                                                                                    dashboard
+fieldId
+id
+isFloating
+isVisible
+name
+position
+size
+type
+worksheet
+
                                                                                                                    Properties
                                                                                                                    dashboard: Dashboard
                                                                                                                    The Dashboard object that contains this object.
                                                                                                                    
+
                                                                                                                    fieldId: undefined | string
                                                                                                                    The field id of the dashboard object if it is a QuickFilter
                                                                                                                    
+
                                                                                                                    id: number
                                                                                                                    The id of the dashboard object
                                                                                                                    
+
                                                                                                                    1.1.0
                                                                                                                    
+
                                                                                                                    isFloating: boolean
                                                                                                                    True if the object is floating in the dashboard.
                                                                                                                    
+
                                                                                                                    1.1.0
                                                                                                                    
+
                                                                                                                    isVisible: boolean
                                                                                                                    True if the object is visible.
                                                                                                                    
+
                                                                                                                    1.1.0
                                                                                                                    
+
                                                                                                                    name: string
                                                                                                                    The name of the dashboard object. This is the name given to the object during authoring.
                                                                                                                    
+
                                                                                                                    1.1.0
                                                                                                                    
+
                                                                                                                    position: Point
                                                                                                                    The coordinates relative to the top-left corner of the dashboard containing this object.
                                                                                                                    
+
                                                                                                                    size: Size
                                                                                                                    The size of the object.
                                                                                                                    
+
                                                                                                                    type: DashboardObjectType
                                                                                                                    What the object represents.
                                                                                                                    
+
                                                                                                                    worksheet: undefined | Worksheet
                                                                                                                    If type returns WORKSHEET or QUICKFILTER, this returns a Worksheet object, undefined otherwise.
                                                                                                                    
+
                                                                                                                    Settings
                                                                                                                    Member Visibility
                                                                                                                    On This Page
                                                                                                                    Properties
                                                                                                                    
diff --git a/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html b/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html
index c5c13766..5a7a32c3 100644
--- a/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html
+++ b/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html
@@ -1,300 +1,36 @@
-
-
-
-	
-	
-	DashboardObjectPositionAndSizeUpdate | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                    
-	
                                                                                                                    
-		
                                                                                                                    
-			
                                                                                                                    
-				
-				
                                                                                                                    
-					
                                                                                                                    
-						Options
-						
                                                                                                                    
-							
                                                                                                                    
-								All
-								
                                                                                                                      
-									
                                                                                                                    • Public
                                                                                                                      • 
-									
                                                                                                                    • Public/Protected
                                                                                                                      • 
-									
                                                                                                                    • All
                                                                                                                      • 
-								
                                                                                                                    
-							
                                                                                                                    
-							
-							
-							
-							
-						
                                                                                                                    
-					
                                                                                                                    
-					Menu
-				
                                                                                                                    
-			
                                                                                                                    
-		
                                                                                                                    
-	
                                                                                                                    
-	
                                                                                                                    
-		
                                                                                                                    
-			
-			
                                                                                                                    Interface DashboardObjectPositionAndSizeUpdate
                                                                                                                    
-		
                                                                                                                    
-	
                                                                                                                    
-
                                                                                                                    
-
                                                                                                                    
-	
                                                                                                                    
-		
                                                                                                                    
-			
                                                                                                                    
-				
                                                                                                                    
-					
                                                                                                                    
-						
                                                                                                                    An object to specify a dashboard object and its new position and size in a dashboard.
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-			
                                                                                                                    
-			
                                                                                                                    
-				
                                                                                                                    Hierarchy
                                                                                                                    
-				
                                                                                                                      
-					
                                                                                                                    • 
-						DashboardObjectPositionAndSizeUpdate
-					
                                                                                                                      • 
-				
                                                                                                                    
-			
                                                                                                                    
-			
                                                                                                                    
-				
                                                                                                                    Index
                                                                                                                    
-				
                                                                                                                    
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    Properties
                                                                                                                    
-							
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-			
                                                                                                                    
-			
                                                                                                                    
-				
                                                                                                                    Properties
                                                                                                                    
-				
                                                                                                                    
-					
-					
                                                                                                                    dashboardObjectID
                                                                                                                    
-					
                                                                                                                    dashboardObjectID: number
                                                                                                                    
-					
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    returns
                                                                                                                    
-							
                                                                                                                    dashboard object ID
                                                                                                                    
-							
                                                                                                                    
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-				
                                                                                                                    
-					
-					
                                                                                                                    height
                                                                                                                    
-					
                                                                                                                    height: number
                                                                                                                    
-					
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    returns
                                                                                                                    
-							
                                                                                                                    height
                                                                                                                    
-							
                                                                                                                    
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-				
                                                                                                                    
-					
-					
                                                                                                                    width
                                                                                                                    
-					
                                                                                                                    width: number
                                                                                                                    
-					
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    returns
                                                                                                                    
-							
                                                                                                                    width
                                                                                                                    
-							
                                                                                                                    
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-				
                                                                                                                    
-					
-					
                                                                                                                    x
                                                                                                                    
-					
                                                                                                                    x: number
                                                                                                                    
-					
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    returns
                                                                                                                    
-							
                                                                                                                    X coordinate
                                                                                                                    
-							
                                                                                                                    
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-				
                                                                                                                    
-					
-					
                                                                                                                    y
                                                                                                                    
-					
                                                                                                                    y: number
                                                                                                                    
-					
-					
                                                                                                                    
-						
                                                                                                                    
-							
                                                                                                                    returns
                                                                                                                    
-							
                                                                                                                    Y coordinate
                                                                                                                    
-							
                                                                                                                    
-						
                                                                                                                    
-					
                                                                                                                    
-				
                                                                                                                    
-			
                                                                                                                    
-		
                                                                                                                    
-		
                                                                                                                    
-			
-			
-		
                                                                                                                    
-	
                                                                                                                    
-
                                                                                                                    
-
                                                                                                                    
-	
                                                                                                                    
-		
                                                                                                                    Legend
                                                                                                                    
-		
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Module
                                                                                                                      • 
-				
                                                                                                                    • Object literal
                                                                                                                      • 
-				
                                                                                                                    • Variable
                                                                                                                      • 
-				
                                                                                                                    • Function
                                                                                                                      • 
-				
                                                                                                                    • Function with type parameter
                                                                                                                      • 
-				
                                                                                                                    • Index signature
                                                                                                                      • 
-				
                                                                                                                    • Type alias
                                                                                                                      • 
-				
                                                                                                                    • Type alias with type parameter
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Enumeration
                                                                                                                      • 
-				
                                                                                                                    • Enumeration member
                                                                                                                      • 
-				
                                                                                                                    • Property
                                                                                                                      • 
-				
                                                                                                                    • Method
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Interface
                                                                                                                      • 
-				
                                                                                                                    • Interface with type parameter
                                                                                                                      • 
-				
                                                                                                                    • Constructor
                                                                                                                      • 
-				
                                                                                                                    • Property
                                                                                                                      • 
-				
                                                                                                                    • Method
                                                                                                                      • 
-				
                                                                                                                    • Index signature
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Class
                                                                                                                      • 
-				
                                                                                                                    • Class with type parameter
                                                                                                                      • 
-				
                                                                                                                    • Constructor
                                                                                                                      • 
-				
                                                                                                                    • Property
                                                                                                                      • 
-				
                                                                                                                    • Method
                                                                                                                      • 
-				
                                                                                                                    • Accessor
                                                                                                                      • 
-				
                                                                                                                    • Index signature
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Inherited constructor
                                                                                                                      • 
-				
                                                                                                                    • Inherited property
                                                                                                                      • 
-				
                                                                                                                    • Inherited method
                                                                                                                      • 
-				
                                                                                                                    • Inherited accessor
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Protected property
                                                                                                                      • 
-				
                                                                                                                    • Protected method
                                                                                                                      • 
-				
                                                                                                                    • Protected accessor
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Private property
                                                                                                                      • 
-				
                                                                                                                    • Private method
                                                                                                                      • 
-				
                                                                                                                    • Private accessor
                                                                                                                      • 
-			
                                                                                                                    
-			
                                                                                                                      
-				
                                                                                                                    • Static property
                                                                                                                      • 
-				
                                                                                                                    • Static method
                                                                                                                      • 
-			
                                                                                                                    
-		
                                                                                                                    
-	
                                                                                                                    
-
                                                                                                                    
-
                                                                                                                    
-
-
-
-
-
\ No newline at end of file
+DashboardObjectPositionAndSizeUpdate | Tableau Extensions API
                                                                                                                    Tableau Extensions API
                                                                                                                      Preparing search index...
                                                                                                                      Interface DashboardObjectPositionAndSizeUpdate
                                                                                                                      An object to specify a dashboard object and its new position and size in a dashboard.
                                                                                                                      
+
                                                                                                                      interface DashboardObjectPositionAndSizeUpdate {
                                                                                                                          dashboardObjectID: number;
                                                                                                                          height: number;
                                                                                                                          width: number;
                                                                                                                          x: number;
                                                                                                                          y: number;
                                                                                                                      }
                                                                                                                      Index
                                                                                                                      Properties
                                                                                                                      dashboardObjectID
+height
+width
+x
+y
+
                                                                                                                      Properties
                                                                                                                      dashboardObjectID: number
                                                                                                                      dashboard object ID
                                                                                                                      
+
                                                                                                                      height: number
                                                                                                                      height
                                                                                                                      
+
                                                                                                                      width: number
                                                                                                                      width
                                                                                                                      
+
                                                                                                                      x: number
                                                                                                                      X coordinate
                                                                                                                      
+
                                                                                                                      y: number
                                                                                                                      Y coordinate
                                                                                                                      
+
                                                                                                                      Settings
                                                                                                                      Member Visibility
                                                                                                                      On This Page
                                                                                                                      Properties
                                                                                                                      
diff --git a/website/static/api/interfaces/datasource.html b/website/static/api/interfaces/datasource.html
index 05ba766f..6b35e5a9 100644
--- a/website/static/api/interfaces/datasource.html
+++ b/website/static/api/interfaces/datasource.html
@@ -1,570 +1,91 @@
-
-
-
-	
-	
-	DataSource | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                      
-	
                                                                                                                      
-		
                                                                                                                      
-			
                                                                                                                      
-				
-				
                                                                                                                      
-					
                                                                                                                      
-						Options
-						
                                                                                                                      
-							
                                                                                                                      
-								All
-								
                                                                                                                        
-									
                                                                                                                      • Public
                                                                                                                        • 
-									
                                                                                                                      • Public/Protected
                                                                                                                        • 
-									
                                                                                                                      • All
                                                                                                                        • 
-								
                                                                                                                      
-							
                                                                                                                      
-							
-							
-							
-							
-						
                                                                                                                      
-					
                                                                                                                      
-					Menu
-				
                                                                                                                      
-			
                                                                                                                      
-		
                                                                                                                      
-	
                                                                                                                      
-	
                                                                                                                      
-		
                                                                                                                      
-			
-			
                                                                                                                      Interface DataSource
                                                                                                                      
-		
                                                                                                                      
-	
                                                                                                                      
-
                                                                                                                      
-
                                                                                                                      
-	
                                                                                                                      
-		
                                                                                                                      
-			
                                                                                                                      
-				
                                                                                                                      
-					
                                                                                                                      
-						
                                                                                                                      Represents the data source used by a Worksheet.
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-			
                                                                                                                      
-			
                                                                                                                      
-				
                                                                                                                      Hierarchy
                                                                                                                      
-				
                                                                                                                        
-					
                                                                                                                      • 
-						DataSource
-					
                                                                                                                        • 
-				
                                                                                                                      
-			
                                                                                                                      
-			
                                                                                                                      
-				
                                                                                                                      Index
                                                                                                                      
-				
                                                                                                                      
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      Properties
                                                                                                                      
-							
-						
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      Methods
                                                                                                                      
-							
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-			
                                                                                                                      
-			
                                                                                                                      
-				
                                                                                                                      Properties
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      extractUpdateTime
                                                                                                                      
-					
                                                                                                                      extractUpdateTime: string | undefined
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      Last update time of the data source's extract, or undefined if this data source is live.
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      fields
                                                                                                                      
-					
                                                                                                                      fields: Array<Field>
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      An array of fields associated with this data source.
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      id
                                                                                                                      
-					
                                                                                                                      id: string
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      Unique string representing this data source.
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      isExtract
                                                                                                                      
-					
                                                                                                                      isExtract: boolean
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      True if this data source is an extract, false otherwise.
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      isPublished
                                                                                                                      
-					
                                                                                                                      isPublished: boolean | undefined
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      True if this data source is published to server, false otherwise. Always undefined prior to Tableau 2021.4.
                                                                                                                      
-							
                                                                                                                      
-							
                                                                                                                      since
                                                                                                                      
-							
                                                                                                                      1.7.0 and Tableau 2021.4
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      name
                                                                                                                      
-					
                                                                                                                      name: string
                                                                                                                      
-					
-					
                                                                                                                      
-						
                                                                                                                      
-							
                                                                                                                      returns
                                                                                                                      
-							
                                                                                                                      The user friendly name of the data source as seen in the UI.
                                                                                                                      
-							
                                                                                                                      
-						
                                                                                                                      
-					
                                                                                                                      
-				
                                                                                                                      
-			
                                                                                                                      
-			
                                                                                                                      
-				
                                                                                                                      Methods
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      getActiveTablesAsync
                                                                                                                      
-					
-					
                                                                                                                        
-						
                                                                                                                      • 
-							
-							
                                                                                                                        
-								
                                                                                                                        
-									
                                                                                                                        throws
                                                                                                                        
-									
                                                                                                                        UnsupportedMethodForDataSourceType error if this method is called on a Cube DataSource or GA.
                                                                                                                        
-									
                                                                                                                        
-									
                                                                                                                        deprecated
                                                                                                                        
-									
                                                                                                                        since version 1.4.0.  Use DataSource.getLogicalTablesAsync.
                                                                                                                        
-									
                                                                                                                        
-								
                                                                                                                        
-							
                                                                                                                        
-							
                                                                                                                        Returns Promise<Array<TableSummary>>
                                                                                                                        
-							
                                                                                                                        An array of table summary objects that are currently used in the data source.
                                                                                                                        
-						
                                                                                                                        • 
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      getConnectionSummariesAsync
                                                                                                                      
-					
-					
                                                                                                                        
-						
                                                                                                                      • 
-							
-							
                                                                                                                        
-							
                                                                                                                        
-							
                                                                                                                        Returns Promise<Array<ConnectionSummary>>
                                                                                                                        
-							
                                                                                                                        An array of descriptions of the connections within this data source.
                                                                                                                        
-						
                                                                                                                        • 
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      getLogicalTableDataAsync
                                                                                                                      
-					
-					
                                                                                                                        
-						
                                                                                                                      • 
-							
-							
                                                                                                                        
-								
                                                                                                                        
-									
                                                                                                                        Gets the underlying data table for the given logical table id.
                                                                                                                        
-								
                                                                                                                        
-								
                                                                                                                        
-									
                                                                                                                        see
                                                                                                                        
-									
                                                                                                                        getLogicalTableDataReaderAsync to read more than 10,000 rows.
                                                                                                                        
-										
                                                                                                                        You can use the getUnderlyingDataOptions.maxRows property to request the number of rows of data to return.
-											If unspecified (maxRows == '0'), the call to getLogicalTableDataAsync requests all rows in the logical table.
-											Note that the maximum number of rows returned from the getLogicalTableDataAsync() method is limited
-											to 10,000 rows. You can use the DataTable property, isTotalRowCountLimited, to test whether there is
-											more data. A value of true indicates that the calling function requested more rows than the limit (10,000) and the
-										underlying data source contains more rows than can be returned.
                                                                                                                        
-										
                                                                                                                        The following example shows use of the getLogicalTableDataAsync() method to get the data from a specific logical table in a data source.
-										The example uses the JavaScript find() method to select the workbook, and uses the getLogicalTablesAsync method to identify the logical table id.
                                                                                                                        
-										
                                                                                                                        const dataSources = await worksheet.getDataSourcesAsync();
-const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
-const logicalTables = await dataSource.getLogicalTablesAsync()
-const dataTable = await dataSource.getLogicalTableDataAsync(logicalTables[0].id);
-console.log(dataTable);
                                                                                                                        
-								
                                                                                                                        
-							
                                                                                                                        
-							
                                                                                                                        Parameters
                                                                                                                        
-							
-							
                                                                                                                        Returns Promise<DataTable>
                                                                                                                        
-							
                                                                                                                        A data table containing the underlying data of the data source.
                                                                                                                        
-						
                                                                                                                        • 
-					
                                                                                                                      
-				
                                                                                                                      
-				
                                                                                                                      
-					
-					
                                                                                                                      getLogicalTablesAsync
                                                                                                                      
-					
-					
                                                                                                                        
-						
                                                                                                                      • 
-							
-							
                                                                                                                        
-								
                                                                                                                        
-									
                                                                                                                        Gets the underlying logical tables used in the data source.
                                                                                                                        
-								
                                                                                                                        
-								
                                                                                                                        
-									
                                                                                                                        since
                                                                                                                        
-									
                                                                                                                        1.4.0
                                                                                                                        
-									
                                                                                                                        
-								
                                                                                                                        
-							
                                                                                                                        
-							
                                                                                                                        Returns Promise<Array<LogicalTable>>
                                                                                                                        
-							
                                                                                                                        An array of logical tables that are currently used in the data source.
                                                                                                                        
-							
                                                                                                                        The following example uses the getLogicalTablesAsync method to print the names of the
-							the logical tables to the console.
                                                                                                                        
-							
                                                                                                                        dataSource.getLogicalTablesAsync().then(function (logicalTables) {
-  // Loop through each table that was used in creating this data source
-  logicalTables.forEach(function (table) {
-     console.log(table.caption);
+
-
-DataSource | Tableau Extensions API
                                                                                                                        Tableau Extensions API
                                                                                                                          Preparing search index...
                                                                                                                          Interface DataSource
                                                                                                                          Represents the data source used by a Worksheet.
                                                                                                                          
+
                                                                                                                          interface DataSource {
                                                                                                                              extractUpdateTime: undefined | string;
                                                                                                                              fields: Field[];
                                                                                                                              id: string;
                                                                                                                              isExtract: boolean;
                                                                                                                              isPublished: undefined | boolean;
                                                                                                                              name: string;
                                                                                                                              getActiveTablesAsync(): Promise<TableSummary[]>;
                                                                                                                              getConnectionSummariesAsync(): Promise<ConnectionSummary[]>;
                                                                                                                              getLogicalTableDataAsync(
                                                                                                                                  logicalTableId: string,
                                                                                                                                  options?: DataSourceUnderlyingDataOptions,
                                                                                                                              ): Promise<DataTable>;
                                                                                                                              getLogicalTablesAsync(): Promise<LogicalTable[]>;
                                                                                                                              getUnderlyingDataAsync(
                                                                                                                                  options?: DataSourceUnderlyingDataOptions,
                                                                                                                              ): Promise<DataTable>;
                                                                                                                              refreshAsync(): Promise<void>;
                                                                                                                          }
                                                                                                                          Index
                                                                                                                          Properties
                                                                                                                          extractUpdateTime
+fields
+id
+isExtract
+isPublished
+name
+
                                                                                                                          Methods
                                                                                                                          getActiveTablesAsync
+getConnectionSummariesAsync
+getLogicalTableDataAsync
+getLogicalTablesAsync
+getUnderlyingDataAsync
+refreshAsync
+
                                                                                                                          Properties
                                                                                                                          extractUpdateTime: undefined | string
                                                                                                                          Last update time of the data source's extract, or undefined if this data source is live.
                                                                                                                          
+
                                                                                                                          fields: Field[]
                                                                                                                          An array of fields associated with this data source.
                                                                                                                          
+
                                                                                                                          id: string
                                                                                                                          Unique string representing this data source.
                                                                                                                          
+
                                                                                                                          isExtract: boolean
                                                                                                                          True if this data source is an extract, false otherwise.
                                                                                                                          
+
                                                                                                                          isPublished: undefined | boolean
                                                                                                                          True if this data source is published to server, false otherwise. Always undefined prior to Tableau 2021.4.
                                                                                                                          
+
                                                                                                                          1.7.0 and Tableau 2021.4
                                                                                                                          
+
                                                                                                                          name: string
                                                                                                                          The user friendly name of the data source as seen in the UI.
                                                                                                                          
+
                                                                                                                          Methods
                                                                                                                          • Returns Promise<TableSummary[]>
                                                                                                                            An array of table summary objects that are currently used in the data source.
                                                                                                                            
+
                                                                                                                            UnsupportedMethodForDataSourceType error if this method is called on a Cube DataSource or GA.
                                                                                                                            
+
                                                                                                                            since version 1.4.0.  Use DataSource.getLogicalTablesAsync.
                                                                                                                            
+
                                                                                                                          • Returns Promise<ConnectionSummary[]>
                                                                                                                            An array of descriptions of the connections within this data source.
                                                                                                                            
+
                                                                                                                          • Gets the underlying data table for the given logical table id.
                                                                                                                            
+
                                                                                                                            Parameters
                                                                                                                            Returns Promise<DataTable>
                                                                                                                            A data table containing the underlying data of the data source.
                                                                                                                            
+
                                                                                                                            getLogicalTableDataReaderAsync to read more than 10,000 rows.
                                                                                                                            
+
                                                                                                                            You can use the getUnderlyingDataOptions.maxRows property to request the number of rows of data to return.
+If unspecified (maxRows == '0'), the call to getLogicalTableDataAsync requests all rows in the logical table.
+Note that the maximum number of rows returned from the getLogicalTableDataAsync() method is limited
+to 10,000 rows. You can use the DataTable property, isTotalRowCountLimited, to test whether there is
+more data. A value of true indicates that the calling function requested more rows than the limit (10,000) and the
+underlying data source contains more rows than can be returned.
                                                                                                                            
+
                                                                                                                            The following example shows use of the getLogicalTableDataAsync() method to get the data from a specific logical table in a data source.
+The example uses the JavaScript find() method to select the workbook, and uses the getLogicalTablesAsync method to identify the logical table id.
                                                                                                                            
+
                                                                                                                            const dataSources = await worksheet.getDataSourcesAsync();
                                                                                                                            const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
                                                                                                                            const logicalTables = await dataSource.getLogicalTablesAsync()
                                                                                                                            const dataTable = await dataSource.getLogicalTableDataAsync(logicalTables[0].id);
                                                                                                                            console.log(dataTable);
+
                                                                                                                            
+
+
                                                                                                                          • Gets the underlying logical tables used in the data source.
                                                                                                                            
+
                                                                                                                            Returns Promise<LogicalTable[]>
                                                                                                                            An array of logical tables that are currently used in the data source.
                                                                                                                            
+
                                                                                                                            The following example uses the getLogicalTablesAsync method to print the names of the
+the logical tables to the console.
                                                                                                                            
+
                                                                                                                            dataSource.getLogicalTablesAsync().then(function (logicalTables) {
                                                                                                                              // Loop through each table that was used in creating this data source
                                                                                                                              logicalTables.forEach(function (table) {
                                                                                                                                 console.log(table.caption);
                                                                                                                              });
                                                                                                                            });
+
                                                                                                                            
 
-        ga('create', '469571326', 'auto');
-        ga('send', 'pageview');
-    
-
-
\ No newline at end of file
+
                                                                                                                            1.4.0
                                                                                                                            
+
                                                                                                                          • Parameters
                                                                                                                            Returns Promise<DataTable>
                                                                                                                            Returns a promise containing a page of data from the underlying data of the data source.
                                                                                                                            
+
                                                                                                                            The following example shows use of the getUnderlyingDataAsync() method to get the underlying data from a specific data source.
+The example uses the JavaScript find() method to select the workbook and data source.
                                                                                                                            
+
                                                                                                                            const dataSources = await worksheet.getDataSourcesAsync();
                                                                                                                            const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
                                                                                                                            const dataTable = await dataSource.getUnderlyingDataAsync();
                                                                                                                            let field = dataTable.columns.find(column => column.fieldName === "Sub-Category");
                                                                                                                            let list = [];
                                                                                                                            for (let row of dataTable.data) {
                                                                                                                                list.push(row[field.index].value);
                                                                                                                            }
                                                                                                                            let values = list.filter((el, i, arr) => arr.indexOf(el) === i);
                                                                                                                            console.log(values);
                                                                                                                            
+
                                                                                                                            
+
+
                                                                                                                            Use DataSource.getLogicalTableDataReaderAsync or DataSource.getLogicalTableDataAsync.
                                                                                                                            
+
                                                                                                                          • This call has the same functionality as clicking the Refresh option on a data source in
+Tableau.  This does not refresh an extract.
                                                                                                                            
+
                                                                                                                            Note
                                                                                                                             The refreshAsync() method is intended to be used in scenarios where manual
+interaction causes a need to refresh the data in the Tableau visualization. The method is not,
+as currently designed, meant to support or emulate streaming or live visualizations.
+Extensions that use the method to refresh aggressively or automatically
+can cause issues on Tableau Server and Tableau Online and are subject to being blocked
+by the Tableau Online administrator.
                                                                                                                            
+
                                                                                                                            
+
                                                                                                                            This call does not currently support refreshing live Google Sheet data sources.
                                                                                                                            
+
                                                                                                                            Returns Promise<void>
                                                                                                                            Promise that resolves when the data source has finished refreshing.
                                                                                                                            
+
                                                                                                                          Settings
                                                                                                                          Member Visibility
                                                                                                                          On This Page
                                                                                                                          Properties
                                                                                                                          Methods
                                                                                                                          
diff --git a/website/static/api/interfaces/datasourceunderlyingdataoptions.html b/website/static/api/interfaces/datasourceunderlyingdataoptions.html
index c2cc1e70..99226c39 100644
--- a/website/static/api/interfaces/datasourceunderlyingdataoptions.html
+++ b/website/static/api/interfaces/datasourceunderlyingdataoptions.html
@@ -1,309 +1,43 @@
-
-
-
-	
-	
-	DataSourceUnderlyingDataOptions | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                          
-	
                                                                                                                          
-		
                                                                                                                          
-			
                                                                                                                          
-				
-				
                                                                                                                          
-					
                                                                                                                          
-						Options
-						
                                                                                                                          
-							
                                                                                                                          
-								All
-								
                                                                                                                            
-									
                                                                                                                          • Public
                                                                                                                            • 
-									
                                                                                                                          • Public/Protected
                                                                                                                            • 
-									
                                                                                                                          • All
                                                                                                                            • 
-								
                                                                                                                          
-							
                                                                                                                          
-							
-							
-							
-							
-						
                                                                                                                          
-					
                                                                                                                          
-					Menu
-				
                                                                                                                          
-			
                                                                                                                          
-		
                                                                                                                          
-	
                                                                                                                          
-	
                                                                                                                          
-		
                                                                                                                          
-			
-			
                                                                                                                          Interface DataSourceUnderlyingDataOptions
                                                                                                                          
-		
                                                                                                                          
-	
                                                                                                                          
-
                                                                                                                          
-
                                                                                                                          
-	
                                                                                                                          
-		
                                                                                                                          
-			
                                                                                                                          
-				
                                                                                                                          
-					
                                                                                                                          
-						
                                                                                                                          Configuration object for fetching data from an data source object.
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-			
                                                                                                                          
-			
                                                                                                                          
-				
                                                                                                                          Hierarchy
                                                                                                                          
-				
                                                                                                                            
-					
                                                                                                                          • 
-						DataSourceUnderlyingDataOptions
-					
                                                                                                                            • 
-				
                                                                                                                          
-			
                                                                                                                          
-			
                                                                                                                          
-				
                                                                                                                          Index
                                                                                                                          
-				
                                                                                                                          
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          Properties
                                                                                                                          
-							
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-			
                                                                                                                          
-			
                                                                                                                          
-				
                                                                                                                          Properties
                                                                                                                          
-				
                                                                                                                          
-					
-					
                                                                                                                          Optional columnsToInclude
                                                                                                                          
-					
                                                                                                                          columnsToInclude: Array<string>
                                                                                                                          
-					
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          The columns to return specified by field name, returns all by default.
                                                                                                                          
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-				
                                                                                                                          
-					
-					
                                                                                                                          Optional columnsToIncludeById
                                                                                                                          
-					
                                                                                                                          columnsToIncludeById: Array<string>
                                                                                                                          
-					
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          The columns to return specified by field id, returns all by default.
-							Since 1.5.0, fieldId is a property of the Column object.
                                                                                                                          
-						
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          since
                                                                                                                          
-							
                                                                                                                          1.5.0
                                                                                                                          
-							
                                                                                                                          
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-				
                                                                                                                          
-					
-					
                                                                                                                          Optional ignoreAliases
                                                                                                                          
-					
                                                                                                                          ignoreAliases: undefined | false | true
                                                                                                                          
-					
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          Do not use aliases specified in the data source in Tableau. Default is false.
                                                                                                                          
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-				
                                                                                                                          
-					
-					
                                                                                                                          Optional includeDataValuesOption
                                                                                                                          
-					
                                                                                                                          includeDataValuesOption: IncludeDataValuesOption
                                                                                                                          
-					
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
-								All properties not requested will be undefined in the DataValue results.
-							This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
                                                                                                                          
-						
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          since
                                                                                                                          
-							
                                                                                                                          1.5.0
                                                                                                                          
-							
                                                                                                                          
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-				
                                                                                                                          
-					
-					
                                                                                                                          Optional maxRows
                                                                                                                          
-					
                                                                                                                          maxRows: undefined | number
                                                                                                                          
-					
-					
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          The maximum number of rows to return. 10,000 by default
                                                                                                                          
-						
                                                                                                                          
-						
                                                                                                                          
-							
                                                                                                                          since
                                                                                                                          
-							
                                                                                                                          1.10.0 and Tableau 2022.4 Consider using a DataTableReader returned by one of the get...DataReaderAsync methods
-								to avoid the 10,000 row limit.
                                                                                                                          
-							
                                                                                                                          
-						
                                                                                                                          
-					
                                                                                                                          
-				
                                                                                                                          
-			
                                                                                                                          
-		
                                                                                                                          
-		
                                                                                                                          
-			
-			
-		
                                                                                                                          
-	
                                                                                                                          
-
                                                                                                                          
-
                                                                                                                          
-	
                                                                                                                          
-		
                                                                                                                          Legend
                                                                                                                          
-		
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Module
                                                                                                                            • 
-				
                                                                                                                          • Object literal
                                                                                                                            • 
-				
                                                                                                                          • Variable
                                                                                                                            • 
-				
                                                                                                                          • Function
                                                                                                                            • 
-				
                                                                                                                          • Function with type parameter
                                                                                                                            • 
-				
                                                                                                                          • Index signature
                                                                                                                            • 
-				
                                                                                                                          • Type alias
                                                                                                                            • 
-				
                                                                                                                          • Type alias with type parameter
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Enumeration
                                                                                                                            • 
-				
                                                                                                                          • Enumeration member
                                                                                                                            • 
-				
                                                                                                                          • Property
                                                                                                                            • 
-				
                                                                                                                          • Method
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Interface
                                                                                                                            • 
-				
                                                                                                                          • Interface with type parameter
                                                                                                                            • 
-				
                                                                                                                          • Constructor
                                                                                                                            • 
-				
                                                                                                                          • Property
                                                                                                                            • 
-				
                                                                                                                          • Method
                                                                                                                            • 
-				
                                                                                                                          • Index signature
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Class
                                                                                                                            • 
-				
                                                                                                                          • Class with type parameter
                                                                                                                            • 
-				
                                                                                                                          • Constructor
                                                                                                                            • 
-				
                                                                                                                          • Property
                                                                                                                            • 
-				
                                                                                                                          • Method
                                                                                                                            • 
-				
                                                                                                                          • Accessor
                                                                                                                            • 
-				
                                                                                                                          • Index signature
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Inherited constructor
                                                                                                                            • 
-				
                                                                                                                          • Inherited property
                                                                                                                            • 
-				
                                                                                                                          • Inherited method
                                                                                                                            • 
-				
                                                                                                                          • Inherited accessor
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Protected property
                                                                                                                            • 
-				
                                                                                                                          • Protected method
                                                                                                                            • 
-				
                                                                                                                          • Protected accessor
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Private property
                                                                                                                            • 
-				
                                                                                                                          • Private method
                                                                                                                            • 
-				
                                                                                                                          • Private accessor
                                                                                                                            • 
-			
                                                                                                                          
-			
                                                                                                                            
-				
                                                                                                                          • Static property
                                                                                                                            • 
-				
                                                                                                                          • Static method
                                                                                                                            • 
-			
                                                                                                                          
-		
                                                                                                                          
-	
                                                                                                                          
-
                                                                                                                          
-
                                                                                                                          
-
-
-
-
-
\ No newline at end of file
+DataSourceUnderlyingDataOptions | Tableau Extensions API
                                                                                                                          Tableau Extensions API
                                                                                                                            Preparing search index...
                                                                                                                            Interface DataSourceUnderlyingDataOptions
                                                                                                                            Configuration object for fetching data from an data source object.
                                                                                                                            
+
                                                                                                                            interface DataSourceUnderlyingDataOptions {
                                                                                                                                columnsToInclude?: string[];
                                                                                                                                columnsToIncludeById?: string[];
                                                                                                                                ignoreAliases?: boolean;
                                                                                                                                includeDataValuesOption?: IncludeDataValuesOption;
                                                                                                                                maxRows?: number;
                                                                                                                            }
                                                                                                                            Index
                                                                                                                            Properties
                                                                                                                            columnsToInclude?
+columnsToIncludeById?
+ignoreAliases?
+includeDataValuesOption?
+maxRows?
+
                                                                                                                            Properties
                                                                                                                            columnsToInclude?: string[]
                                                                                                                            The columns to return specified by field name, returns all by default.
                                                                                                                            
+
                                                                                                                            columnsToIncludeById?: string[]
                                                                                                                            The columns to return specified by field id, returns all by default.
+Since 1.5.0, fieldId is a property of the Column object.
                                                                                                                            
+
                                                                                                                            1.5.0
                                                                                                                            
+
                                                                                                                            ignoreAliases?: boolean
                                                                                                                            Do not use aliases specified in the data source in Tableau. Default is false.
                                                                                                                            
+
                                                                                                                            includeDataValuesOption?: IncludeDataValuesOption
                                                                                                                            Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues.
+All properties not requested will be undefined in the DataValue results.
+This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.
                                                                                                                            
+
                                                                                                                            1.5.0
                                                                                                                            
+
                                                                                                                            maxRows?: number
                                                                                                                            The maximum number of rows to return. 10,000 by default
                                                                                                                            
+
                                                                                                                            1.10.0 and Tableau 2022.4 Consider using a DataTableReader returned by one of the get...DataReaderAsync methods
+to avoid the 10,000 row limit.
                                                                                                                            
+
                                                                                                                            Settings
                                                                                                                            Member Visibility
                                                                                                                            On This Page
                                                                                                                            Properties
                                                                                                                            
diff --git a/website/static/api/interfaces/datatable.html b/website/static/api/interfaces/datatable.html
index af07b47f..000805a6 100644
--- a/website/static/api/interfaces/datatable.html
+++ b/website/static/api/interfaces/datatable.html
@@ -1,347 +1,51 @@
-
-
-
-	
-	
-	DataTable | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                            
-	
                                                                                                                            
-		
                                                                                                                            
-			
                                                                                                                            
-				
-				
                                                                                                                            
-					
                                                                                                                            
-						Options
-						
                                                                                                                            
-							
                                                                                                                            
-								All
-								
                                                                                                                              
-									
                                                                                                                            • Public
                                                                                                                              • 
-									
                                                                                                                            • Public/Protected
                                                                                                                              • 
-									
                                                                                                                            • All
                                                                                                                              • 
-								
                                                                                                                            
-							
                                                                                                                            
-							
-							
-							
-							
-						
                                                                                                                            
-					
                                                                                                                            
-					Menu
-				
                                                                                                                            
-			
                                                                                                                            
-		
                                                                                                                            
-	
                                                                                                                            
-	
                                                                                                                            
-		
                                                                                                                            
-			
-			
                                                                                                                            Interface DataTable
                                                                                                                            
-		
                                                                                                                            
-	
                                                                                                                            
-
                                                                                                                            
-
                                                                                                                            
-	
                                                                                                                            
-		
                                                                                                                            
-			
                                                                                                                            
-				
                                                                                                                            Hierarchy
                                                                                                                            
-				
                                                                                                                              
-					
                                                                                                                            • 
-						DataTable
-					
                                                                                                                              • 
-				
                                                                                                                            
-			
                                                                                                                            
-			
                                                                                                                            
-				
                                                                                                                            Index
                                                                                                                            
-				
                                                                                                                            
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            Properties
                                                                                                                            
-							
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-			
                                                                                                                            
-			
                                                                                                                            
-				
                                                                                                                            Properties
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            columns
                                                                                                                            
-					
                                                                                                                            columns: Array<Column>
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            The column information, including the name, data type, and index..
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            data
                                                                                                                            
-					
                                                                                                                            data: Array<Array<DataValue>>
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            A two-dimensional array of data without the sheet or column
-									metadata. The first array index is the row index and the second
-								array index is the column index.
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            Optional isSummaryData
                                                                                                                            
-					
                                                                                                                            isSummaryData: undefined | false | true
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            Whether the data is summary data or underlying data.
-								Returns true for summary data.
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            Optional isTotalRowCountLimited
                                                                                                                            
-					
                                                                                                                            isTotalRowCountLimited: undefined | false | true
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            True if the rows returned have been limited to the maximum number of retrievable rows.
-									A value of true indicates that the caller requested more rows than the limit
-									and the underlying data source contains more rows than can be returned.
-									isTotalRowCountLimited can be true in the case of ...
-									getAllPagesAsync with more than 4,000,000 rows in the summary or underlying data.
-									getLogicalTableDataAsync or getUnderlyingTableDataAsync with more than 10,000 rows in the data.
-									In all these cases, limits can be avoided by processing the data in page sized chunks with DataTableReader.
-								isTotalRowCountLimited is always false in the results of DataTableReader.getPageAsync().
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            Optional marksInfo
                                                                                                                            
-					
                                                                                                                            marksInfo: Array<MarkInfo>
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            An array of information about marks.  Each mark in the array corresponds
-									to a row in the data of this DataTable. MarkInfo is currently only partially
-								available within results from getSelectedMarksAsync / getMarksAsync.
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            name
                                                                                                                            
-					
                                                                                                                            name: string
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            Either "Underlying Data Table" or "Summary Data Table".
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-				
                                                                                                                            
-					
-					
                                                                                                                            totalRowCount
                                                                                                                            
-					
                                                                                                                            totalRowCount: number
                                                                                                                            
-					
-					
                                                                                                                            
-						
                                                                                                                            
-							
                                                                                                                            returns
                                                                                                                            
-							
                                                                                                                            The number of rows in the returned data.
                                                                                                                            
-							
                                                                                                                            
-						
                                                                                                                            
-					
                                                                                                                            
-				
                                                                                                                            
-			
                                                                                                                            
-		
                                                                                                                            
-		
                                                                                                                            
-			
-			
-		
                                                                                                                            
-	
                                                                                                                            
-
                                                                                                                            
-
                                                                                                                            
-	
                                                                                                                            
-		
                                                                                                                            Legend
                                                                                                                            
-		
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Module
                                                                                                                              • 
-				
                                                                                                                            • Object literal
                                                                                                                              • 
-				
                                                                                                                            • Variable
                                                                                                                              • 
-				
                                                                                                                            • Function
                                                                                                                              • 
-				
                                                                                                                            • Function with type parameter
                                                                                                                              • 
-				
                                                                                                                            • Index signature
                                                                                                                              • 
-				
                                                                                                                            • Type alias
                                                                                                                              • 
-				
                                                                                                                            • Type alias with type parameter
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Enumeration
                                                                                                                              • 
-				
                                                                                                                            • Enumeration member
                                                                                                                              • 
-				
                                                                                                                            • Property
                                                                                                                              • 
-				
                                                                                                                            • Method
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Interface
                                                                                                                              • 
-				
                                                                                                                            • Interface with type parameter
                                                                                                                              • 
-				
                                                                                                                            • Constructor
                                                                                                                              • 
-				
                                                                                                                            • Property
                                                                                                                              • 
-				
                                                                                                                            • Method
                                                                                                                              • 
-				
                                                                                                                            • Index signature
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Class
                                                                                                                              • 
-				
                                                                                                                            • Class with type parameter
                                                                                                                              • 
-				
                                                                                                                            • Constructor
                                                                                                                              • 
-				
                                                                                                                            • Property
                                                                                                                              • 
-				
                                                                                                                            • Method
                                                                                                                              • 
-				
                                                                                                                            • Accessor
                                                                                                                              • 
-				
                                                                                                                            • Index signature
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Inherited constructor
                                                                                                                              • 
-				
                                                                                                                            • Inherited property
                                                                                                                              • 
-				
                                                                                                                            • Inherited method
                                                                                                                              • 
-				
                                                                                                                            • Inherited accessor
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Protected property
                                                                                                                              • 
-				
                                                                                                                            • Protected method
                                                                                                                              • 
-				
                                                                                                                            • Protected accessor
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Private property
                                                                                                                              • 
-				
                                                                                                                            • Private method
                                                                                                                              • 
-				
                                                                                                                            • Private accessor
                                                                                                                              • 
-			
                                                                                                                            
-			
                                                                                                                              
-				
                                                                                                                            • Static property
                                                                                                                              • 
-				
                                                                                                                            • Static method
                                                                                                                              • 
-			
                                                                                                                            
-		
                                                                                                                            
-	
                                                                                                                            
-
                                                                                                                            
-
                                                                                                                            
-
-
-
-
-
\ No newline at end of file
+DataTable | Tableau Extensions API
                                                                                                                            Tableau Extensions API
                                                                                                                              Preparing search index...
                                                                                                                              Interface DataTable
                                                                                                                              interface DataTable {
                                                                                                                                  columns: Column[];
                                                                                                                                  data: DataValue[][];
                                                                                                                                  isSummaryData?: boolean;
                                                                                                                                  isTotalRowCountLimited?: boolean;
                                                                                                                                  marksInfo?: MarkInfo[];
                                                                                                                                  name: string;
                                                                                                                                  totalRowCount: number;
                                                                                                                              }
                                                                                                                              Index
                                                                                                                              Properties
                                                                                                                              columns
+data
+isSummaryData?
+isTotalRowCountLimited?
+marksInfo?
+name
+totalRowCount
+
                                                                                                                              Properties
                                                                                                                              columns: Column[]
                                                                                                                              The column information, including the name, data type, and index..
                                                                                                                              
+
                                                                                                                              data: DataValue[][]
                                                                                                                              A two-dimensional array of data without the sheet or column
+metadata. The first array index is the row index and the second
+array index is the column index.
                                                                                                                              
+
                                                                                                                              isSummaryData?: boolean
                                                                                                                              Whether the data is summary data or underlying data.
+Returns true for summary data.
                                                                                                                              
+
                                                                                                                              isTotalRowCountLimited?: boolean
                                                                                                                              True if the rows returned have been limited to the maximum number of retrievable rows.
+A value of true indicates that the caller requested more rows than the limit
+and the underlying data source contains more rows than can be returned.
+isTotalRowCountLimited can be true in the case of ...
+getAllPagesAsync with more than 4,000,000 rows in the summary or underlying data.
+getLogicalTableDataAsync or getUnderlyingTableDataAsync with more than 10,000 rows in the data.
+In all these cases, limits can be avoided by processing the data in page sized chunks with DataTableReader.
+isTotalRowCountLimited is always false in the results of DataTableReader.getPageAsync().
                                                                                                                              
+
                                                                                                                              marksInfo?: MarkInfo[]
                                                                                                                              An array of information about marks.  Each mark in the array corresponds
+to a row in the data of this DataTable. MarkInfo is currently only partially
+available within results from getSelectedMarksAsync / getMarksAsync.
                                                                                                                              
+
                                                                                                                              name: string
                                                                                                                              Either "Underlying Data Table" or "Summary Data Table".
                                                                                                                              
+
                                                                                                                              totalRowCount: number
                                                                                                                              The number of rows in the returned data.
                                                                                                                              
+
                                                                                                                              Settings
                                                                                                                              Member Visibility
                                                                                                                              On This Page
                                                                                                                              Properties
                                                                                                                              
diff --git a/website/static/api/interfaces/datatablereader.html b/website/static/api/interfaces/datatablereader.html
index d44bcf6d..d75e40ca 100644
--- a/website/static/api/interfaces/datatablereader.html
+++ b/website/static/api/interfaces/datatablereader.html
@@ -1,393 +1,79 @@
-
-
-
-	
-	
-	DataTableReader | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                              
-	
                                                                                                                              
-		
                                                                                                                              
-			
                                                                                                                              
-				
-				
                                                                                                                              
-					
                                                                                                                              
-						Options
-						
                                                                                                                              
-							
                                                                                                                              
-								All
-								
                                                                                                                                
-									
                                                                                                                              • Public
                                                                                                                                • 
-									
                                                                                                                              • Public/Protected
                                                                                                                                • 
-									
                                                                                                                              • All
                                                                                                                                • 
-								
                                                                                                                              
-							
                                                                                                                              
-							
-							
-							
-							
-						
                                                                                                                              
-					
                                                                                                                              
-					Menu
-				
                                                                                                                              
-			
                                                                                                                              
-		
                                                                                                                              
-	
                                                                                                                              
-	
                                                                                                                              
-		
                                                                                                                              
-			
-			
                                                                                                                              Interface DataTableReader
                                                                                                                              
-		
                                                                                                                              
-	
                                                                                                                              
-
                                                                                                                              
-
                                                                                                                              
-	
                                                                                                                              
-		
                                                                                                                              
-			
                                                                                                                              
-				
                                                                                                                              
-					
                                                                                                                              
-						
                                                                                                                              A DataTableReader allows iteration over summary or underlying data by pages.
-							The page size is established when the DataTableReader is created.
-							(See getLogicalTableDataReaderAsync, getSummaryDataReaderAsync, or getUnderlyingTableDataReaderAsync.)
-						The normal sequence of operations would be to
                                                                                                                              
-						
                                                                                                                                
-							
                                                                                                                              1. Create the DataTableReader for the desired DataTable.
                                                                                                                                2. 
-							
                                                                                                                              2. Use DataTableReader.totalRowCount or DataTableReader.pageCount to discover how many rows or pages are in the desired DataTable.
                                                                                                                                3. 
-							
                                                                                                                              3. Call DataTableReader.getPageAsync() to get the page(s) desired. Each page is a DataTable for that page.
-							Alternatively, based on the DataTableReader.totalRowCount, DataTableReader.getAllPagesAsync can be used to fetch the entire DataTable.
                                                                                                                                4. 
-							
                                                                                                                              4. Call DataTableReader.releaseAsync() to free up resources.
                                                                                                                                5. 
-						
                                                                                                                              
-					
                                                                                                                              
-					
                                                                                                                              Notes for usage of a DataTableReader:
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              1. Since DataTableReaders consume server resources, an inactive DataTableReader will be automatically
-						released after 60 minutes of inactivity. (A new DataTableReader can be created at that time, if needed.)
                                                                                                                                2. 
-						
                                                                                                                              2. Calling getPageAsync() after an explicit or automatic releaseAsync() will throw an exception.
                                                                                                                                3. 
-						
                                                                                                                              3. Only one active DataTableReader per logical table id is supported.
                                                                                                                                4. 
-						
                                                                                                                              4. There are still limits on the number of rows supported for underlying and logical data table readers.
-							The default limit is approximately 1 million rows of data for getUnderlyingTableDataReaderAsync,
-							and approximately 32 million cells (rows * columns) for getLogicalTableDataReaderAsync.
-							Administrators may change these limits to better match computing resources with the Tableau Server (Cloud) or Tableau Desktop options:
-							ExtensionsAndEmbeddingReaderRowLimit for getUnderlyingTableDataReaderAsync or
-						ExtensionsAndEmbeddingReaderCellLimit for getLogicalTableDataReaderAsync.
                                                                                                                                5. 
-					
                                                                                                                              
-					
                                                                                                                              
-						
                                                                                                                              since
                                                                                                                              
-						
                                                                                                                              1.10.0 and Tableau 2022.4
                                                                                                                              
-						
                                                                                                                              
-					
                                                                                                                              
-				
                                                                                                                              
-			
                                                                                                                              
-			
                                                                                                                              
-				
                                                                                                                              Hierarchy
                                                                                                                              
-				
                                                                                                                                
-					
                                                                                                                              • 
-						DataTableReader
-					
                                                                                                                                • 
-				
                                                                                                                              
-			
                                                                                                                              
-			
                                                                                                                              
-				
                                                                                                                              Index
                                                                                                                              
-				
                                                                                                                              
-					
                                                                                                                              
-						
                                                                                                                              
-							
                                                                                                                              Properties
                                                                                                                              
-							
-						
                                                                                                                              
-						
                                                                                                                              
-							
                                                                                                                              Methods
                                                                                                                              
-							
-						
                                                                                                                              
-					
                                                                                                                              
-				
                                                                                                                              
-			
                                                                                                                              
-			
                                                                                                                              
-				
                                                                                                                              Properties
                                                                                                                              
-				
                                                                                                                              
-					
-					
                                                                                                                              pageCount
                                                                                                                              
-					
                                                                                                                              pageCount: number
                                                                                                                              
-					
-					
                                                                                                                              
-						
                                                                                                                              
-							
                                                                                                                              returns
                                                                                                                              
-							
                                                                                                                              The number of pages in the full data table. The last page could be a partial page.
                                                                                                                              
-							
                                                                                                                              
-						
                                                                                                                              
-					
                                                                                                                              
-				
                                                                                                                              
-				
                                                                                                                              
-					
-					
                                                                                                                              totalRowCount
                                                                                                                              
-					
                                                                                                                              totalRowCount: number
                                                                                                                              
-					
-					
                                                                                                                              
-						
                                                                                                                              
-							
                                                                                                                              returns
                                                                                                                              
-							
                                                                                                                              The number of rows in the full data table.
                                                                                                                              
-							
                                                                                                                              
-						
                                                                                                                              
-					
                                                                                                                              
-				
                                                                                                                              
-			
                                                                                                                              
-			
                                                                                                                              
-				
                                                                                                                              Methods
                                                                                                                              
-				
                                                                                                                              
-					
-					
                                                                                                                              getAllPagesAsync
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • getAllPagesAsync(maxRows?: undefined | number): Promise<DataTable>
                                                                                                                                • 
-					
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • 
-							
-							
                                                                                                                                
-								
                                                                                                                                
-									
                                                                                                                                Get all the pages of data into a single DataTable.
-										Calls to getAllPagesAsync() after releaseAsync() will throw an exception.
-										To protect against possible browser failure, getAllPagesAsync will cap the data at a maximum of 400 pages.
-									With a default pageRowCount of 10,000 this will give you a maximum of 4,000,000 rows of data.
                                                                                                                                
-								
                                                                                                                                
-								
                                                                                                                                If sizes are larger than this, please process your data in page size chunks.
                                                                                                                                
-							
                                                                                                                                
-							
                                                                                                                                Parameters
                                                                                                                                
-							
                                                                                                                                  
-								
                                                                                                                                • 
-									
                                                                                                                                  Optional maxRows: undefined | number
                                                                                                                                  
-									
                                                                                                                                  
-										
                                                                                                                                  Limits the request to maxRows. If maxRows === 0, requests all rows.
                                                                                                                                  
-									
                                                                                                                                  
-								
                                                                                                                                  • 
-							
                                                                                                                                
-							
                                                                                                                                Returns Promise<DataTable>
                                                                                                                                
-							
                                                                                                                                A DataTable containing all the data available to the DataTableReader with the maximum page count above.
                                                                                                                                
-							
                                                                                                                                // To simplify the example, we assume we have less than 4m rows of data
-// Since we are fetching all of the data, use the default page size in getSummaryDataReaderAsync
-const dataTableReader = await worksheet.getSummaryDataReaderAsync();
-const dataTable = await dataTableReader.getAllPagesAsync();
-await dataTableReader.releaseAsync();
-// ... process the data table ...
                                                                                                                                
-						
                                                                                                                                • 
-					
                                                                                                                              
-				
                                                                                                                              
-				
                                                                                                                              
-					
-					
                                                                                                                              getPageAsync
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • getPageAsync(pageNumber: number): Promise<DataTable>
                                                                                                                                • 
-					
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • 
-							
-							
                                                                                                                                
-								
                                                                                                                                
-									
                                                                                                                                Get a page of data. The page is returned as a DataTable.
-									Calls to getPageAsync() after releaseAsync() will throw an exception.
                                                                                                                                
-								
                                                                                                                                
-							
                                                                                                                                
-							
                                                                                                                                Parameters
                                                                                                                                
-							
                                                                                                                                  
-								
                                                                                                                                • 
-									
                                                                                                                                  pageNumber: number
                                                                                                                                  
-									
                                                                                                                                  
-										
                                                                                                                                  The page number (zero-indexed) to fetch. The page number should be treated
-										like an array index with range: 0 <= pageNumber < pageCount.
                                                                                                                                  
-									
                                                                                                                                  
-								
                                                                                                                                  • 
-							
                                                                                                                                
-							
                                                                                                                                Returns Promise<DataTable>
                                                                                                                                
-							
                                                                                                                                A DataTable containing the requested page. The number of rows returned
-							can be less than the page size at the end of the data.
                                                                                                                                
-							
                                                                                                                                const pageRowCount = 200;
-const dataTableReader = await worksheet.getSummaryDataReaderAsync(pageRowCount, options);
-for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
-  const currentPageDataTable = await dataTableReader.getPageAsync(currentPage);
-  // ... process current page ...
-}
-await dataTableReader.releaseAsync();
                                                                                                                                
-						
                                                                                                                                • 
-					
                                                                                                                              
-				
                                                                                                                              
-				
                                                                                                                              
-					
-					
                                                                                                                              releaseAsync
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • releaseAsync(): Promise<void>
                                                                                                                                • 
-					
                                                                                                                              
-					
                                                                                                                                
-						
                                                                                                                              • 
-							
-							
                                                                                                                                
-								
                                                                                                                                
-									
                                                                                                                                Release all resources held by the DataTableReader.
-										Calling this when done with the DataTableReader is required practice as it frees up resources.
-									Calls to getPageAsync() after releaseAsync() will throw an exception.
                                                                                                                                
-								
                                                                                                                                
-							
                                                                                                                                
-							
                                                                                                                                Returns Promise<void>
                                                                                                                                
-						
                                                                                                                                • 
-					
                                                                                                                              
-				
                                                                                                                              
-			
                                                                                                                              
-		
                                                                                                                              
-		
                                                                                                                              
-			
-			
-		
                                                                                                                              
-	
                                                                                                                              
-
                                                                                                                              
-
                                                                                                                              
-	
                                                                                                                              
-		
                                                                                                                              Legend
                                                                                                                              
-		
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Module
                                                                                                                                • 
-				
                                                                                                                              • Object literal
                                                                                                                                • 
-				
                                                                                                                              • Variable
                                                                                                                                • 
-				
                                                                                                                              • Function
                                                                                                                                • 
-				
                                                                                                                              • Function with type parameter
                                                                                                                                • 
-				
                                                                                                                              • Index signature
                                                                                                                                • 
-				
                                                                                                                              • Type alias
                                                                                                                                • 
-				
                                                                                                                              • Type alias with type parameter
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Enumeration
                                                                                                                                • 
-				
                                                                                                                              • Enumeration member
                                                                                                                                • 
-				
                                                                                                                              • Property
                                                                                                                                • 
-				
                                                                                                                              • Method
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Interface
                                                                                                                                • 
-				
                                                                                                                              • Interface with type parameter
                                                                                                                                • 
-				
                                                                                                                              • Constructor
                                                                                                                                • 
-				
                                                                                                                              • Property
                                                                                                                                • 
-				
                                                                                                                              • Method
                                                                                                                                • 
-				
                                                                                                                              • Index signature
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Class
                                                                                                                                • 
-				
                                                                                                                              • Class with type parameter
                                                                                                                                • 
-				
                                                                                                                              • Constructor
                                                                                                                                • 
-				
                                                                                                                              • Property
                                                                                                                                • 
-				
                                                                                                                              • Method
                                                                                                                                • 
-				
                                                                                                                              • Accessor
                                                                                                                                • 
-				
                                                                                                                              • Index signature
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Inherited constructor
                                                                                                                                • 
-				
                                                                                                                              • Inherited property
                                                                                                                                • 
-				
                                                                                                                              • Inherited method
                                                                                                                                • 
-				
                                                                                                                              • Inherited accessor
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Protected property
                                                                                                                                • 
-				
                                                                                                                              • Protected method
                                                                                                                                • 
-				
                                                                                                                              • Protected accessor
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Private property
                                                                                                                                • 
-				
                                                                                                                              • Private method
                                                                                                                                • 
-				
                                                                                                                              • Private accessor
                                                                                                                                • 
-			
                                                                                                                              
-			
                                                                                                                                
-				
                                                                                                                              • Static property
                                                                                                                                • 
-				
                                                                                                                              • Static method
                                                                                                                                • 
-			
                                                                                                                              
-		
                                                                                                                              
-	
                                                                                                                              
-
                                                                                                                              
-
                                                                                                                              
-
-
-DataTableReader | Tableau Extensions API
                                                                                                                              Tableau Extensions API
                                                                                                                                Preparing search index...
                                                                                                                                Interface DataTableReader
                                                                                                                                A DataTableReader allows iteration over summary or underlying data by pages.
+The page size is established when the DataTableReader is created.
+(See getLogicalTableDataReaderAsync, getSummaryDataReaderAsync, or getUnderlyingTableDataReaderAsync.)
+The normal sequence of operations would be to
                                                                                                                                
+
                                                                                                                                  
+
                                                                                                                                1. Create the DataTableReader for the desired DataTable.
                                                                                                                                  2. 
+
                                                                                                                                2. Use DataTableReader.totalRowCount or DataTableReader.pageCount to discover how many rows or pages are in the desired DataTable.
                                                                                                                                  3. 
+
                                                                                                                                3. Call DataTableReader.getPageAsync() to get the page(s) desired. Each page is a DataTable for that page.
+Alternatively, based on the DataTableReader.totalRowCount, DataTableReader.getAllPagesAsync can be used to fetch the entire DataTable.
                                                                                                                                  4. 
+
                                                                                                                                4. Call DataTableReader.releaseAsync() to free up resources.
                                                                                                                                  5. 
+
                                                                                                                                
+
                                                                                                                                Notes for usage of a DataTableReader:
                                                                                                                                
+
                                                                                                                                  
+
                                                                                                                                1. Since DataTableReaders consume server resources, an inactive DataTableReader will be automatically
+released after 60 minutes of inactivity. (A new DataTableReader can be created at that time, if needed.)
                                                                                                                                  2. 
+
                                                                                                                                2. Calling getPageAsync() after an explicit or automatic releaseAsync() will throw an exception.
                                                                                                                                  3. 
+
                                                                                                                                3. Only one active DataTableReader per logical table id is supported.
                                                                                                                                  4. 
+
                                                                                                                                4. There are still limits on the number of rows supported for underlying and logical data table readers.
+The default limit is approximately 1 million rows of data for getUnderlyingTableDataReaderAsync,
+and approximately 32 million cells (rows * columns) for getLogicalTableDataReaderAsync.
+Administrators may change these limits to better match computing resources with the Tableau Server (Cloud) or Tableau Desktop options:
+ExtensionsAndEmbeddingReaderRowLimit for getUnderlyingTableDataReaderAsync or
+ExtensionsAndEmbeddingReaderCellLimit for getLogicalTableDataReaderAsync.
                                                                                                                                  5. 
+
                                                                                                                                
+
                                                                                                                                1.10.0 and Tableau 2022.4
                                                                                                                                
+
                                                                                                                                interface DataTableReader {
                                                                                                                                    pageCount: number;
                                                                                                                                    totalRowCount: number;
                                                                                                                                    getAllPagesAsync(maxRows?: number): Promise<DataTable>;
                                                                                                                                    getPageAsync(pageNumber: number): Promise<DataTable>;
                                                                                                                                    releaseAsync(): Promise<void>;
                                                                                                                                }
                                                                                                                                Index
                                                                                                                                Properties
                                                                                                                                pageCount
+totalRowCount
+
                                                                                                                                Methods
                                                                                                                                getAllPagesAsync
+getPageAsync
+releaseAsync
+
                                                                                                                                Properties
                                                                                                                                pageCount: number
                                                                                                                                The number of pages in the full data table. The last page could be a partial page.
                                                                                                                                
+
                                                                                                                                totalRowCount: number
                                                                                                                                The number of rows in the full data table.
                                                                                                                                
+
                                                                                                                                Methods
                                                                                                                                • Get all the pages of data into a single DataTable.
+Calls to getAllPagesAsync() after releaseAsync() will throw an exception.
+To protect against possible browser failure, getAllPagesAsync will cap the data at a maximum of 400 pages.
+With a default pageRowCount of 10,000 this will give you a maximum of 4,000,000 rows of data.
                                                                                                                                  
+
                                                                                                                                  If sizes are larger than this, please process your data in page size chunks.
                                                                                                                                  
+
                                                                                                                                  Parameters
                                                                                                                                  • OptionalmaxRows: number
                                                                                                                                    Limits the request to maxRows. If maxRows === 0, requests all rows.
                                                                                                                                    
+
                                                                                                                                  Returns Promise<DataTable>
                                                                                                                                  A DataTable containing all the data available to the DataTableReader with the maximum page count above.
                                                                                                                                  
+
                                                                                                                                  // To simplify the example, we assume we have less than 4m rows of data
                                                                                                                                  // Since we are fetching all of the data, use the default page size in getSummaryDataReaderAsync
                                                                                                                                  const dataTableReader = await worksheet.getSummaryDataReaderAsync();
                                                                                                                                  const dataTable = await dataTableReader.getAllPagesAsync();
                                                                                                                                  await dataTableReader.releaseAsync();
                                                                                                                                  // ... process the data table ...
+
                                                                                                                                  
 
-        ga('create', '469571326', 'auto');
-        ga('send', 'pageview');
-    
-
-
\ No newline at end of file
+
                                                                                                                                • Get a page of data. The page is returned as a DataTable.
+Calls to getPageAsync() after releaseAsync() will throw an exception.
                                                                                                                                  
+
                                                                                                                                  Parameters
                                                                                                                                  • pageNumber: number
                                                                                                                                    The page number (zero-indexed) to fetch. The page number should be treated
+like an array index with range: 0 <= pageNumber < pageCount.
                                                                                                                                    
+
                                                                                                                                  Returns Promise<DataTable>
                                                                                                                                  A DataTable containing the requested page. The number of rows returned
+can be less than the page size at the end of the data.
                                                                                                                                  
+
                                                                                                                                  const pageRowCount = 200;
                                                                                                                                  const dataTableReader = await worksheet.getSummaryDataReaderAsync(pageRowCount, options);
                                                                                                                                  for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
                                                                                                                                    const currentPageDataTable = await dataTableReader.getPageAsync(currentPage);
                                                                                                                                    // ... process current page ...
                                                                                                                                  }
                                                                                                                                  await dataTableReader.releaseAsync();
+
                                                                                                                                  
+
+
                                                                                                                                • Release all resources held by the DataTableReader.
+Calling this when done with the DataTableReader is required practice as it frees up resources.
+Calls to getPageAsync() after releaseAsync() will throw an exception.
                                                                                                                                  
+
                                                                                                                                  Returns Promise<void>
                                                                                                                                Settings
                                                                                                                                Member Visibility
                                                                                                                                On This Page
                                                                                                                                Properties
                                                                                                                                Methods
                                                                                                                                
diff --git a/website/static/api/interfaces/datavalue.html b/website/static/api/interfaces/datavalue.html
index 3ccae1cd..328a1ec9 100644
--- a/website/static/api/interfaces/datavalue.html
+++ b/website/static/api/interfaces/datavalue.html
@@ -1,309 +1,47 @@
-
-
-
-	
-	
-	DataValue | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                
-	
                                                                                                                                
-		
                                                                                                                                
-			
                                                                                                                                
-				
-				
                                                                                                                                
-					
                                                                                                                                
-						Options
-						
                                                                                                                                
-							
                                                                                                                                
-								All
-								
                                                                                                                                  
-									
                                                                                                                                • Public
                                                                                                                                  • 
-									
                                                                                                                                • Public/Protected
                                                                                                                                  • 
-									
                                                                                                                                • All
                                                                                                                                  • 
-								
                                                                                                                                
-							
                                                                                                                                
-							
-							
-							
-							
-						
                                                                                                                                
-					
                                                                                                                                
-					Menu
-				
                                                                                                                                
-			
                                                                                                                                
-		
                                                                                                                                
-	
                                                                                                                                
-	
                                                                                                                                
-		
                                                                                                                                
-			
-			
                                                                                                                                Interface DataValue
                                                                                                                                
-		
                                                                                                                                
-	
                                                                                                                                
-
                                                                                                                                
-
                                                                                                                                
-	
                                                                                                                                
-		
                                                                                                                                
-			
                                                                                                                                
-				
                                                                                                                                Hierarchy
                                                                                                                                
-				
                                                                                                                                  
-					
                                                                                                                                • 
-						DataValue
-					
                                                                                                                                  • 
-				
                                                                                                                                
-			
                                                                                                                                
-			
                                                                                                                                
-				
                                                                                                                                Index
                                                                                                                                
-				
                                                                                                                                
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                Properties
                                                                                                                                
-							
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-			
                                                                                                                                
-			
                                                                                                                                
-				
                                                                                                                                Properties
                                                                                                                                
-				
                                                                                                                                
-					
-					
                                                                                                                                Optional aliasValue
                                                                                                                                
-					
                                                                                                                                aliasValue: undefined | string
                                                                                                                                
-					
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                returns
                                                                                                                                
-							
                                                                                                                                The alias of a value only if hasAlias is true.
                                                                                                                                
-							
                                                                                                                                
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-				
                                                                                                                                
-					
-					
                                                                                                                                Optional formattedValue
                                                                                                                                
-					
                                                                                                                                formattedValue: undefined | string
                                                                                                                                
-					
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                returns
                                                                                                                                
-							
                                                                                                                                The value formatted according to the locale and the
-								formatting applied to the field or parameter.
                                                                                                                                
-							
                                                                                                                                
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-				
                                                                                                                                
-					
-					
                                                                                                                                Optional hasAlias
                                                                                                                                
-					
                                                                                                                                hasAlias: undefined | false | true
                                                                                                                                
-					
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                returns
                                                                                                                                
-							
                                                                                                                                Indicates if the DataValue contains an alias (for DataValues of Parameters with domain restriction type
-								ParameterValueType.List).
                                                                                                                                
-							
                                                                                                                                
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-				
                                                                                                                                
-					
-					
                                                                                                                                nativeValue
                                                                                                                                
-					
                                                                                                                                nativeValue: any
                                                                                                                                
-					
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                since
                                                                                                                                
-							
                                                                                                                                1.4.0
                                                                                                                                
-							
                                                                                                                                
-							
                                                                                                                                returns
                                                                                                                                
-							
                                                                                                                                The raw native value as a JavaScript type, which is
-									one of string, number, boolean, or Date object. Please note that special
-									values are returned as null. The actual special value can be found
-									in formattedValue, which would be something like 'Null', or 'No-Access'.
-									Using nativeValue can greatly simplify your error checking since all values
-								will be their native type value or null.
                                                                                                                                
-							
                                                                                                                                
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-				
                                                                                                                                
-					
-					
                                                                                                                                value
                                                                                                                                
-					
                                                                                                                                value: any
                                                                                                                                
-					
-					
                                                                                                                                
-						
                                                                                                                                
-							
                                                                                                                                since
                                                                                                                                
-							
                                                                                                                                1.2.0 Fixes the type to be the raw native value rather than a string.
                                                                                                                                
-							
                                                                                                                                
-							
                                                                                                                                returns
                                                                                                                                
-							
                                                                                                                                Contains the raw native value as a JavaScript type, which is
-									one of string, number, boolean, or Date (as a string). Please note that special
-									values, regardless of type, are always returned as a String surrounded by
-								percent signs, such as '%null%', or '%no-access%'.
                                                                                                                                
-							
                                                                                                                                
-						
                                                                                                                                
-					
                                                                                                                                
-				
                                                                                                                                
-			
                                                                                                                                
-		
                                                                                                                                
-		
                                                                                                                                
-			
-			
-		
                                                                                                                                
-	
                                                                                                                                
-
                                                                                                                                
-
                                                                                                                                
-	
                                                                                                                                
-		
                                                                                                                                Legend
                                                                                                                                
-		
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Module
                                                                                                                                  • 
-				
                                                                                                                                • Object literal
                                                                                                                                  • 
-				
                                                                                                                                • Variable
                                                                                                                                  • 
-				
                                                                                                                                • Function
                                                                                                                                  • 
-				
                                                                                                                                • Function with type parameter
                                                                                                                                  • 
-				
                                                                                                                                • Index signature
                                                                                                                                  • 
-				
                                                                                                                                • Type alias
                                                                                                                                  • 
-				
                                                                                                                                • Type alias with type parameter
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Enumeration
                                                                                                                                  • 
-				
                                                                                                                                • Enumeration member
                                                                                                                                  • 
-				
                                                                                                                                • Property
                                                                                                                                  • 
-				
                                                                                                                                • Method
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Interface
                                                                                                                                  • 
-				
                                                                                                                                • Interface with type parameter
                                                                                                                                  • 
-				
                                                                                                                                • Constructor
                                                                                                                                  • 
-				
                                                                                                                                • Property
                                                                                                                                  • 
-				
                                                                                                                                • Method
                                                                                                                                  • 
-				
                                                                                                                                • Index signature
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Class
                                                                                                                                  • 
-				
                                                                                                                                • Class with type parameter
                                                                                                                                  • 
-				
                                                                                                                                • Constructor
                                                                                                                                  • 
-				
                                                                                                                                • Property
                                                                                                                                  • 
-				
                                                                                                                                • Method
                                                                                                                                  • 
-				
                                                                                                                                • Accessor
                                                                                                                                  • 
-				
                                                                                                                                • Index signature
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Inherited constructor
                                                                                                                                  • 
-				
                                                                                                                                • Inherited property
                                                                                                                                  • 
-				
                                                                                                                                • Inherited method
                                                                                                                                  • 
-				
                                                                                                                                • Inherited accessor
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Protected property
                                                                                                                                  • 
-				
                                                                                                                                • Protected method
                                                                                                                                  • 
-				
                                                                                                                                • Protected accessor
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Private property
                                                                                                                                  • 
-				
                                                                                                                                • Private method
                                                                                                                                  • 
-				
                                                                                                                                • Private accessor
                                                                                                                                  • 
-			
                                                                                                                                
-			
                                                                                                                                  
-				
                                                                                                                                • Static property
                                                                                                                                  • 
-				
                                                                                                                                • Static method
                                                                                                                                  • 
-			
                                                                                                                                
-		
                                                                                                                                
-	
                                                                                                                                
-
                                                                                                                                
-
                                                                                                                                
-
-
-
-
-
\ No newline at end of file
+DataValue | Tableau Extensions API
                                                                                                                                Tableau Extensions API
                                                                                                                                  Preparing search index...
                                                                                                                                  Interface DataValue
                                                                                                                                  interface DataValue {
                                                                                                                                      aliasValue?: string;
                                                                                                                                      formattedValue?: string;
                                                                                                                                      hasAlias?: boolean;
                                                                                                                                      nativeValue: any;
                                                                                                                                      value: any;
                                                                                                                                  }
                                                                                                                                  Index
                                                                                                                                  Properties
                                                                                                                                  aliasValue?
+formattedValue?
+hasAlias?
+nativeValue
+value
+
                                                                                                                                  Properties
                                                                                                                                  aliasValue?: string
                                                                                                                                  The alias of a value only if hasAlias is true.
                                                                                                                                  
+
                                                                                                                                  formattedValue?: string
                                                                                                                                  The value formatted according to the locale and the
+formatting applied to the field or parameter.
                                                                                                                                  
+
                                                                                                                                  hasAlias?: boolean
                                                                                                                                  Indicates if the DataValue contains an alias (for DataValues of Parameters with domain restriction type
+ParameterValueType.List).
                                                                                                                                  
+
                                                                                                                                  nativeValue: any
                                                                                                                                  1.4.0
                                                                                                                                  
+
                                                                                                                                  The raw native value as a JavaScript type, which is
+one of string, number, boolean, or Date object. Please note that special
+values are returned as null. The actual special value can be found
+in formattedValue, which would be something like 'Null', or 'No-Access'.
+Using nativeValue can greatly simplify your error checking since all values
+will be their native type value or null.
                                                                                                                                  
+
                                                                                                                                  value: any
                                                                                                                                  1.2.0 Fixes the type to be the raw native value rather than a string.
                                                                                                                                  
+
                                                                                                                                  Contains the raw native value as a JavaScript type, which is
+one of string, number, boolean, or Date (as a string). Please note that special
+values, regardless of type, are always returned as a String surrounded by
+percent signs, such as '%null%', or '%no-access%'.
                                                                                                                                  
+
                                                                                                                                  Settings
                                                                                                                                  Member Visibility
                                                                                                                                  On This Page
                                                                                                                                  Properties
                                                                                                                                  
diff --git a/website/static/api/interfaces/dialogmessageevent.html b/website/static/api/interfaces/dialogmessageevent.html
index 5da27762..874180a1 100644
--- a/website/static/api/interfaces/dialogmessageevent.html
+++ b/website/static/api/interfaces/dialogmessageevent.html
@@ -1,268 +1,36 @@
-
-
-
-	
-	
-	DialogMessageEvent | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                  
-	
                                                                                                                                  
-		
                                                                                                                                  
-			
                                                                                                                                  
-				
-				
                                                                                                                                  
-					
                                                                                                                                  
-						Options
-						
                                                                                                                                  
-							
                                                                                                                                  
-								All
-								
                                                                                                                                    
-									
                                                                                                                                  • Public
                                                                                                                                    • 
-									
                                                                                                                                  • Public/Protected
                                                                                                                                    • 
-									
                                                                                                                                  • All
                                                                                                                                    • 
-								
                                                                                                                                  
-							
                                                                                                                                  
-							
-							
-							
-							
-						
                                                                                                                                  
-					
                                                                                                                                  
-					Menu
-				
                                                                                                                                  
-			
                                                                                                                                  
-		
                                                                                                                                  
-	
                                                                                                                                  
-	
                                                                                                                                  
-		
                                                                                                                                  
-			
-			
                                                                                                                                  Interface DialogMessageEvent
                                                                                                                                  
-		
                                                                                                                                  
-	
                                                                                                                                  
-
                                                                                                                                  
-
                                                                                                                                  
-	
                                                                                                                                  
-		
                                                                                                                                  
-			
                                                                                                                                  
-				
                                                                                                                                  
-					
                                                                                                                                  
-						
                                                                                                                                  An event which is raised when the dialog has a message for the underlying extension (sent using tableau.extensions.ui.sendDialogMessageAsync), or vice versa.
-							Should be listened for directly from the tableau.extensions.ui object.
-							For example, when the dialog sends a message to the extension using tableau.extensions.ui.sendDialogMessageAsync method,
-						the extension should be listening for this event and handling it.
                                                                                                                                  
-					
                                                                                                                                  
-				
                                                                                                                                  
-			
                                                                                                                                  
-			
                                                                                                                                  
-				
                                                                                                                                  Hierarchy
                                                                                                                                  
-				
-			
                                                                                                                                  
-			
                                                                                                                                  
-				
                                                                                                                                  Index
                                                                                                                                  
-				
                                                                                                                                  
-					
                                                                                                                                  
-						
                                                                                                                                  
-							
                                                                                                                                  Properties
                                                                                                                                  
-							
-						
                                                                                                                                  
-					
                                                                                                                                  
-				
                                                                                                                                  
-			
                                                                                                                                  
-			
                                                                                                                                  
-				
                                                                                                                                  Properties
                                                                                                                                  
-				
                                                                                                                                  
-					
-					
                                                                                                                                  message
                                                                                                                                  
-					
                                                                                                                                  message: string
                                                                                                                                  
-					
-					
                                                                                                                                  
-						
                                                                                                                                  
-							
                                                                                                                                  returns
                                                                                                                                  
-							
                                                                                                                                  the message that was sent to/from the dialog.
                                                                                                                                  
-							
                                                                                                                                  
-						
                                                                                                                                  
-					
                                                                                                                                  
-				
                                                                                                                                  
-				
                                                                                                                                  
-					
-					
                                                                                                                                  Optional sourceDialogUrl
                                                                                                                                  
-					
                                                                                                                                  sourceDialogUrl: undefined | string
                                                                                                                                  
-					
-					
                                                                                                                                  
-						
                                                                                                                                  
-							
                                                                                                                                  returns
                                                                                                                                  
-							
                                                                                                                                  the url of the dialog that sent the message.
-								If undefined, the message was sent by the host extension itself.
                                                                                                                                  
-							
                                                                                                                                  
-						
                                                                                                                                  
-					
                                                                                                                                  
-				
                                                                                                                                  
-				
                                                                                                                                  
-					
-					
                                                                                                                                  type
                                                                                                                                  
-					
                                                                                                                                  type: TableauEventType
                                                                                                                                  
-					
-					
                                                                                                                                  
-						
                                                                                                                                  
-							
                                                                                                                                  returns
                                                                                                                                  
-							
                                                                                                                                  The type of event which this class is representing.
                                                                                                                                  
-							
                                                                                                                                  
-						
                                                                                                                                  
-					
                                                                                                                                  
-				
                                                                                                                                  
-			
                                                                                                                                  
-		
                                                                                                                                  
-		
                                                                                                                                  
-			
-			
-		
                                                                                                                                  
-	
                                                                                                                                  
-
                                                                                                                                  
-
                                                                                                                                  
-	
                                                                                                                                  
-		
                                                                                                                                  Legend
                                                                                                                                  
-		
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Module
                                                                                                                                    • 
-				
                                                                                                                                  • Object literal
                                                                                                                                    • 
-				
                                                                                                                                  • Variable
                                                                                                                                    • 
-				
                                                                                                                                  • Function
                                                                                                                                    • 
-				
                                                                                                                                  • Function with type parameter
                                                                                                                                    • 
-				
                                                                                                                                  • Index signature
                                                                                                                                    • 
-				
                                                                                                                                  • Type alias
                                                                                                                                    • 
-				
                                                                                                                                  • Type alias with type parameter
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Enumeration
                                                                                                                                    • 
-				
                                                                                                                                  • Enumeration member
                                                                                                                                    • 
-				
                                                                                                                                  • Property
                                                                                                                                    • 
-				
                                                                                                                                  • Method
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Interface
                                                                                                                                    • 
-				
                                                                                                                                  • Interface with type parameter
                                                                                                                                    • 
-				
                                                                                                                                  • Constructor
                                                                                                                                    • 
-				
                                                                                                                                  • Property
                                                                                                                                    • 
-				
                                                                                                                                  • Method
                                                                                                                                    • 
-				
                                                                                                                                  • Index signature
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Class
                                                                                                                                    • 
-				
                                                                                                                                  • Class with type parameter
                                                                                                                                    • 
-				
                                                                                                                                  • Constructor
                                                                                                                                    • 
-				
                                                                                                                                  • Property
                                                                                                                                    • 
-				
                                                                                                                                  • Method
                                                                                                                                    • 
-				
                                                                                                                                  • Accessor
                                                                                                                                    • 
-				
                                                                                                                                  • Index signature
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Inherited constructor
                                                                                                                                    • 
-				
                                                                                                                                  • Inherited property
                                                                                                                                    • 
-				
                                                                                                                                  • Inherited method
                                                                                                                                    • 
-				
                                                                                                                                  • Inherited accessor
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Protected property
                                                                                                                                    • 
-				
                                                                                                                                  • Protected method
                                                                                                                                    • 
-				
                                                                                                                                  • Protected accessor
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Private property
                                                                                                                                    • 
-				
                                                                                                                                  • Private method
                                                                                                                                    • 
-				
                                                                                                                                  • Private accessor
                                                                                                                                    • 
-			
                                                                                                                                  
-			
                                                                                                                                    
-				
                                                                                                                                  • Static property
                                                                                                                                    • 
-				
                                                                                                                                  • Static method
                                                                                                                                    • 
-			
                                                                                                                                  
-		
                                                                                                                                  
-	
                                                                                                                                  
-
                                                                                                                                  
-
                                                                                                                                  
-
-
-
-
-
\ No newline at end of file
+DialogMessageEvent | Tableau Extensions API
                                                                                                                                  Tableau Extensions API
                                                                                                                                    Preparing search index...
                                                                                                                                    Interface DialogMessageEvent
                                                                                                                                    An event which is raised when the dialog has a message for the underlying extension (sent using tableau.extensions.ui.sendDialogMessageAsync), or vice versa.
+Should be listened for directly from the tableau.extensions.ui object.
+For example, when the dialog sends a message to the extension using tableau.extensions.ui.sendDialogMessageAsync method,
+the extension should be listening for this event and handling it.
                                                                                                                                    
+
                                                                                                                                    interface DialogMessageEvent {
                                                                                                                                        message: string;
                                                                                                                                        sourceDialogUrl?: string;
                                                                                                                                        type: TableauEventType;
                                                                                                                                    }
                                                                                                                                    Hierarchy (View Summary)
                                                                                                                                    Index
                                                                                                                                    Properties
                                                                                                                                    message
+sourceDialogUrl?
+type
+
                                                                                                                                    Properties
                                                                                                                                    message: string
                                                                                                                                    the message that was sent to/from the dialog.
                                                                                                                                    
+
                                                                                                                                    sourceDialogUrl?: string
                                                                                                                                    the url of the dialog that sent the message.
+If undefined, the message was sent by the host extension itself.
                                                                                                                                    
+
                                                                                                                                    type: TableauEventType
                                                                                                                                    The type of event which this class is representing.
                                                                                                                                    
+
                                                                                                                                    Settings
                                                                                                                                    Member Visibility
                                                                                                                                    On This Page
                                                                                                                                    Properties
                                                                                                                                    
diff --git a/website/static/api/interfaces/dialogoptions.html b/website/static/api/interfaces/dialogoptions.html
index d5a4c7d7..97b6fb5e 100644
--- a/website/static/api/interfaces/dialogoptions.html
+++ b/website/static/api/interfaces/dialogoptions.html
@@ -1,250 +1,32 @@
-
-
-
-	
-	
-	DialogOptions | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                    
-	
                                                                                                                                    
-		
                                                                                                                                    
-			
                                                                                                                                    
-				
-				
                                                                                                                                    
-					
                                                                                                                                    
-						Options
-						
                                                                                                                                    
-							
                                                                                                                                    
-								All
-								
                                                                                                                                      
-									
                                                                                                                                    • Public
                                                                                                                                      • 
-									
                                                                                                                                    • Public/Protected
                                                                                                                                      • 
-									
                                                                                                                                    • All
                                                                                                                                      • 
-								
                                                                                                                                    
-							
                                                                                                                                    
-							
-							
-							
-							
-						
                                                                                                                                    
-					
                                                                                                                                    
-					Menu
-				
                                                                                                                                    
-			
                                                                                                                                    
-		
                                                                                                                                    
-	
                                                                                                                                    
-	
                                                                                                                                    
-		
                                                                                                                                    
-			
-			
                                                                                                                                    Interface DialogOptions
                                                                                                                                    
-		
                                                                                                                                    
-	
                                                                                                                                    
-
                                                                                                                                    
-
                                                                                                                                    
-	
                                                                                                                                    
-		
                                                                                                                                    
-			
                                                                                                                                    
-				
                                                                                                                                    Hierarchy
                                                                                                                                    
-				
                                                                                                                                      
-					
                                                                                                                                    • 
-						DialogOptions
-					
                                                                                                                                      • 
-				
                                                                                                                                    
-			
                                                                                                                                    
-			
                                                                                                                                    
-				
                                                                                                                                    Index
                                                                                                                                    
-				
                                                                                                                                    
-					
                                                                                                                                    
-						
                                                                                                                                    
-							
                                                                                                                                    Properties
                                                                                                                                    
-							
-						
                                                                                                                                    
-					
                                                                                                                                    
-				
                                                                                                                                    
-			
                                                                                                                                    
-			
                                                                                                                                    
-				
                                                                                                                                    Properties
                                                                                                                                    
-				
                                                                                                                                    
-					
-					
                                                                                                                                    Optional dialogStyle
                                                                                                                                    
-					
                                                                                                                                    dialogStyle: DialogStyle
                                                                                                                                    
-					
-					
                                                                                                                                    
-						
                                                                                                                                    
-							
                                                                                                                                    Specifies the style for the popup dialog.
                                                                                                                                    
-						
                                                                                                                                    
-						
                                                                                                                                    
-							
                                                                                                                                    since
                                                                                                                                    
-							
                                                                                                                                    1.10.0 and Tableau 2022.4
                                                                                                                                    
-							
                                                                                                                                    
-						
                                                                                                                                    
-					
                                                                                                                                    
-				
                                                                                                                                    
-				
                                                                                                                                    
-					
-					
                                                                                                                                    Optional height
                                                                                                                                    
-					
                                                                                                                                    height: undefined | number
                                                                                                                                    
-					
-					
                                                                                                                                    
-						
                                                                                                                                    
-							
                                                                                                                                    Specifies the suggested height (in pixels) of the popup dialog.  Not guaranteed to be exactly that height.
                                                                                                                                    
-						
                                                                                                                                    
-					
                                                                                                                                    
-				
                                                                                                                                    
-				
                                                                                                                                    
-					
-					
                                                                                                                                    Optional width
                                                                                                                                    
-					
                                                                                                                                    width: undefined | number
                                                                                                                                    
-					
-					
                                                                                                                                    
-						
                                                                                                                                    
-							
                                                                                                                                    Specifies the suggested width (in pixels) of dialog to display.  Not guaranteed to be exactly that width.
                                                                                                                                    
-						
                                                                                                                                    
-					
                                                                                                                                    
-				
                                                                                                                                    
-			
                                                                                                                                    
-		
                                                                                                                                    
-		
                                                                                                                                    
-			
-			
-		
                                                                                                                                    
-	
                                                                                                                                    
-
                                                                                                                                    
-
                                                                                                                                    
-	
                                                                                                                                    
-		
                                                                                                                                    Legend
                                                                                                                                    
-		
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Module
                                                                                                                                      • 
-				
                                                                                                                                    • Object literal
                                                                                                                                      • 
-				
                                                                                                                                    • Variable
                                                                                                                                      • 
-				
                                                                                                                                    • Function
                                                                                                                                      • 
-				
                                                                                                                                    • Function with type parameter
                                                                                                                                      • 
-				
                                                                                                                                    • Index signature
                                                                                                                                      • 
-				
                                                                                                                                    • Type alias
                                                                                                                                      • 
-				
                                                                                                                                    • Type alias with type parameter
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Enumeration
                                                                                                                                      • 
-				
                                                                                                                                    • Enumeration member
                                                                                                                                      • 
-				
                                                                                                                                    • Property
                                                                                                                                      • 
-				
                                                                                                                                    • Method
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Interface
                                                                                                                                      • 
-				
                                                                                                                                    • Interface with type parameter
                                                                                                                                      • 
-				
                                                                                                                                    • Constructor
                                                                                                                                      • 
-				
                                                                                                                                    • Property
                                                                                                                                      • 
-				
                                                                                                                                    • Method
                                                                                                                                      • 
-				
                                                                                                                                    • Index signature
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Class
                                                                                                                                      • 
-				
                                                                                                                                    • Class with type parameter
                                                                                                                                      • 
-				
                                                                                                                                    • Constructor
                                                                                                                                      • 
-				
                                                                                                                                    • Property
                                                                                                                                      • 
-				
                                                                                                                                    • Method
                                                                                                                                      • 
-				
                                                                                                                                    • Accessor
                                                                                                                                      • 
-				
                                                                                                                                    • Index signature
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Inherited constructor
                                                                                                                                      • 
-				
                                                                                                                                    • Inherited property
                                                                                                                                      • 
-				
                                                                                                                                    • Inherited method
                                                                                                                                      • 
-				
                                                                                                                                    • Inherited accessor
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Protected property
                                                                                                                                      • 
-				
                                                                                                                                    • Protected method
                                                                                                                                      • 
-				
                                                                                                                                    • Protected accessor
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Private property
                                                                                                                                      • 
-				
                                                                                                                                    • Private method
                                                                                                                                      • 
-				
                                                                                                                                    • Private accessor
                                                                                                                                      • 
-			
                                                                                                                                    
-			
                                                                                                                                      
-				
                                                                                                                                    • Static property
                                                                                                                                      • 
-				
                                                                                                                                    • Static method
                                                                                                                                      • 
-			
                                                                                                                                    
-		
                                                                                                                                    
-	
                                                                                                                                    
-
                                                                                                                                    
-
                                                                                                                                    
-
-
-
-
-
\ No newline at end of file
+DialogOptions | Tableau Extensions API
                                                                                                                                    Tableau Extensions API
                                                                                                                                      Preparing search index...
                                                                                                                                      Interface DialogOptions
                                                                                                                                      interface DialogOptions {
                                                                                                                                          dialogStyle?: DialogStyle;
                                                                                                                                          height?: number;
                                                                                                                                          width?: number;
                                                                                                                                      }
                                                                                                                                      Index
                                                                                                                                      Properties
                                                                                                                                      dialogStyle?
+height?
+width?
+
                                                                                                                                      Properties
                                                                                                                                      dialogStyle?: DialogStyle
                                                                                                                                      Specifies the style for the popup dialog.
                                                                                                                                      
+
                                                                                                                                      1.10.0 and Tableau 2022.4
                                                                                                                                      
+
                                                                                                                                      height?: number
                                                                                                                                      Specifies the suggested height (in pixels) of the popup dialog.  Not guaranteed to be exactly that height.
                                                                                                                                      
+
                                                                                                                                      width?: number
                                                                                                                                      Specifies the suggested width (in pixels) of dialog to display.  Not guaranteed to be exactly that width.
                                                                                                                                      
+
                                                                                                                                      Settings
                                                                                                                                      Member Visibility
                                                                                                                                      On This Page
                                                                                                                                      Properties
                                                                                                                                      
diff --git a/website/static/api/interfaces/encoding.html b/website/static/api/interfaces/encoding.html
index 555e13a5..287bfe8f 100644
--- a/website/static/api/interfaces/encoding.html
+++ b/website/static/api/interfaces/encoding.html
@@ -1,286 +1,37 @@
-
-
-
-	
-	
-	Encoding | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                      
-	
                                                                                                                                      
-		
                                                                                                                                      
-			
                                                                                                                                      
-				
-				
                                                                                                                                      
-					
                                                                                                                                      
-						Options
-						
                                                                                                                                      
-							
                                                                                                                                      
-								All
-								
                                                                                                                                        
-									
                                                                                                                                      • Public
                                                                                                                                        • 
-									
                                                                                                                                      • Public/Protected
                                                                                                                                        • 
-									
                                                                                                                                      • All
                                                                                                                                        • 
-								
                                                                                                                                      
-							
                                                                                                                                      
-							
-							
-							
-							
-						
                                                                                                                                      
-					
                                                                                                                                      
-					Menu
-				
                                                                                                                                      
-			
                                                                                                                                      
-		
                                                                                                                                      
-	
                                                                                                                                      
-	
                                                                                                                                      
-		
                                                                                                                                      
-			
-			
                                                                                                                                      Interface Encoding
                                                                                                                                      
-		
                                                                                                                                      
-	
                                                                                                                                      
-
                                                                                                                                      
-
                                                                                                                                      
-	
                                                                                                                                      
-		
                                                                                                                                      
-			
                                                                                                                                      
-				
                                                                                                                                      
-					
                                                                                                                                      
-						
                                                                                                                                      since
                                                                                                                                      
-						
                                                                                                                                      1.11.0
-							Represents a single field and its associated encoding on a marks card
                                                                                                                                      
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-			
                                                                                                                                      
-			
                                                                                                                                      
-				
                                                                                                                                      Hierarchy
                                                                                                                                      
-				
                                                                                                                                        
-					
                                                                                                                                      • 
-						Encoding
-					
                                                                                                                                        • 
-				
                                                                                                                                      
-			
                                                                                                                                      
-			
                                                                                                                                      
-				
                                                                                                                                      Index
                                                                                                                                      
-				
                                                                                                                                      
-					
                                                                                                                                      
-						
                                                                                                                                      
-							
                                                                                                                                      Properties
                                                                                                                                      
-							
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-			
                                                                                                                                      
-			
                                                                                                                                      
-				
                                                                                                                                      Properties
                                                                                                                                      
-				
                                                                                                                                      
-					
-					
                                                                                                                                      field
                                                                                                                                      
-					
                                                                                                                                      field: FieldInstance
                                                                                                                                      
-					
-					
                                                                                                                                      
-						
                                                                                                                                      
-							
                                                                                                                                      returns
                                                                                                                                      
-							
                                                                                                                                      Field and its properties
                                                                                                                                      
-							
                                                                                                                                      
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-				
                                                                                                                                      
-					
-					
                                                                                                                                      fieldEncodingId
                                                                                                                                      
-					
                                                                                                                                      fieldEncodingId: string
                                                                                                                                      
-					
-					
                                                                                                                                      
-						
                                                                                                                                      
-							
                                                                                                                                      returns
                                                                                                                                      
-							
                                                                                                                                      The unique representation of the encodings,
-								This allows to identify the duplicate fields that are added to encodings.
                                                                                                                                      
-							
                                                                                                                                      
-							
                                                                                                                                      since
                                                                                                                                      
-							
                                                                                                                                      1.13.0
                                                                                                                                      
-							
                                                                                                                                      
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-				
                                                                                                                                      
-					
-					
                                                                                                                                      id
                                                                                                                                      
-					
                                                                                                                                      id: string
                                                                                                                                      
-					
-					
                                                                                                                                      
-						
                                                                                                                                      
-							
                                                                                                                                      returns
                                                                                                                                      
-							
                                                                                                                                      inbuilt encoding type or the custom encoding
                                                                                                                                      
-							
                                                                                                                                      
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-				
                                                                                                                                      
-					
-					
                                                                                                                                      type
                                                                                                                                      
-					
                                                                                                                                      type: EncodingType
                                                                                                                                      
-					
-					
                                                                                                                                      
-						
                                                                                                                                      
-							
                                                                                                                                      returns
                                                                                                                                      
-							
                                                                                                                                      type of the encoding
                                                                                                                                      
-							
                                                                                                                                      
-						
                                                                                                                                      
-					
                                                                                                                                      
-				
                                                                                                                                      
-			
                                                                                                                                      
-		
                                                                                                                                      
-		
                                                                                                                                      
-			
-			
-		
                                                                                                                                      
-	
                                                                                                                                      
-
                                                                                                                                      
-
                                                                                                                                      
-	
                                                                                                                                      
-		
                                                                                                                                      Legend
                                                                                                                                      
-		
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Module
                                                                                                                                        • 
-				
                                                                                                                                      • Object literal
                                                                                                                                        • 
-				
                                                                                                                                      • Variable
                                                                                                                                        • 
-				
                                                                                                                                      • Function
                                                                                                                                        • 
-				
                                                                                                                                      • Function with type parameter
                                                                                                                                        • 
-				
                                                                                                                                      • Index signature
                                                                                                                                        • 
-				
                                                                                                                                      • Type alias
                                                                                                                                        • 
-				
                                                                                                                                      • Type alias with type parameter
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Enumeration
                                                                                                                                        • 
-				
                                                                                                                                      • Enumeration member
                                                                                                                                        • 
-				
                                                                                                                                      • Property
                                                                                                                                        • 
-				
                                                                                                                                      • Method
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Interface
                                                                                                                                        • 
-				
                                                                                                                                      • Interface with type parameter
                                                                                                                                        • 
-				
                                                                                                                                      • Constructor
                                                                                                                                        • 
-				
                                                                                                                                      • Property
                                                                                                                                        • 
-				
                                                                                                                                      • Method
                                                                                                                                        • 
-				
                                                                                                                                      • Index signature
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Class
                                                                                                                                        • 
-				
                                                                                                                                      • Class with type parameter
                                                                                                                                        • 
-				
                                                                                                                                      • Constructor
                                                                                                                                        • 
-				
                                                                                                                                      • Property
                                                                                                                                        • 
-				
                                                                                                                                      • Method
                                                                                                                                        • 
-				
                                                                                                                                      • Accessor
                                                                                                                                        • 
-				
                                                                                                                                      • Index signature
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Inherited constructor
                                                                                                                                        • 
-				
                                                                                                                                      • Inherited property
                                                                                                                                        • 
-				
                                                                                                                                      • Inherited method
                                                                                                                                        • 
-				
                                                                                                                                      • Inherited accessor
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Protected property
                                                                                                                                        • 
-				
                                                                                                                                      • Protected method
                                                                                                                                        • 
-				
                                                                                                                                      • Protected accessor
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Private property
                                                                                                                                        • 
-				
                                                                                                                                      • Private method
                                                                                                                                        • 
-				
                                                                                                                                      • Private accessor
                                                                                                                                        • 
-			
                                                                                                                                      
-			
                                                                                                                                        
-				
                                                                                                                                      • Static property
                                                                                                                                        • 
-				
                                                                                                                                      • Static method
                                                                                                                                        • 
-			
                                                                                                                                      
-		
                                                                                                                                      
-	
                                                                                                                                      
-
                                                                                                                                      
-
                                                                                                                                      
-
-
-
-
-
\ No newline at end of file
+Encoding | Tableau Extensions API
                                                                                                                                      Tableau Extensions API
                                                                                                                                        Preparing search index...
                                                                                                                                        Interface Encoding
                                                                                                                                        1.11.0
+Represents a single field and its associated encoding on a marks card
                                                                                                                                        
+
                                                                                                                                        interface Encoding {
                                                                                                                                            field: FieldInstance;
                                                                                                                                            fieldEncodingId: string;
                                                                                                                                            id: string;
                                                                                                                                            type: EncodingType;
                                                                                                                                        }
                                                                                                                                        Index
                                                                                                                                        Properties
                                                                                                                                        field
+fieldEncodingId
+id
+type
+
                                                                                                                                        Properties
                                                                                                                                        field: FieldInstance
                                                                                                                                        Field and its properties
                                                                                                                                        
+
                                                                                                                                        fieldEncodingId: string
                                                                                                                                        The unique representation of the encodings,
+This allows to identify the duplicate fields that are added to encodings.
                                                                                                                                        
+
                                                                                                                                        1.13.0
                                                                                                                                        
+
                                                                                                                                        id: string
                                                                                                                                        inbuilt encoding type or the custom encoding
                                                                                                                                        
+
                                                                                                                                        type: EncodingType
                                                                                                                                        type of the encoding
                                                                                                                                        
+
                                                                                                                                        Settings
                                                                                                                                        Member Visibility
                                                                                                                                        On This Page
                                                                                                                                        Properties
                                                                                                                                        
diff --git a/website/static/api/interfaces/environment.html b/website/static/api/interfaces/environment.html
index 48604789..10e51498 100644
--- a/website/static/api/interfaces/environment.html
+++ b/website/static/api/interfaces/environment.html
@@ -1,430 +1,76 @@
-
-
-
-	
-	
-	Environment | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                        
-	
                                                                                                                                        
-		
                                                                                                                                        
-			
                                                                                                                                        
-				
-				
                                                                                                                                        
-					
                                                                                                                                        
-						Options
-						
                                                                                                                                        
-							
                                                                                                                                        
-								All
-								
                                                                                                                                          
-									
                                                                                                                                        • Public
                                                                                                                                          • 
-									
                                                                                                                                        • Public/Protected
                                                                                                                                          • 
-									
                                                                                                                                        • All
                                                                                                                                          • 
-								
                                                                                                                                        
-							
                                                                                                                                        
-							
-							
-							
-							
-						
                                                                                                                                        
-					
                                                                                                                                        
-					Menu
-				
                                                                                                                                        
-			
                                                                                                                                        
-		
                                                                                                                                        
-	
                                                                                                                                        
-	
                                                                                                                                        
-		
                                                                                                                                        
-			
-			
                                                                                                                                        Interface Environment
                                                                                                                                        
-		
                                                                                                                                        
-	
                                                                                                                                        
-
                                                                                                                                        
-
                                                                                                                                        
-	
                                                                                                                                        
-		
                                                                                                                                        
-			
                                                                                                                                        
-				
                                                                                                                                        
-					
                                                                                                                                        
-						
                                                                                                                                        The environment namespace provides a way to programmatically gather
-						information about the environment in which the Extensions is running.
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-			
                                                                                                                                        
-			
                                                                                                                                        
-				
                                                                                                                                        Hierarchy
                                                                                                                                        
-				
                                                                                                                                          
-					
                                                                                                                                        • 
-						Environment
-					
                                                                                                                                          • 
-				
                                                                                                                                        
-			
                                                                                                                                        
-			
                                                                                                                                        
-				
                                                                                                                                        Index
                                                                                                                                        
-				
                                                                                                                                        
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        Properties
                                                                                                                                        
-							
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-			
                                                                                                                                        
-			
                                                                                                                                        
-				
                                                                                                                                        Properties
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        apiVersion
                                                                                                                                        
-					
                                                                                                                                        apiVersion: string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The version of the API being used by the Extensions.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        context
                                                                                                                                        
-					
                                                                                                                                        context: ExtensionContext
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        Current context in which the Extensions is running (i.e. Desktop or Server).
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        Optional country
                                                                                                                                        
-					
                                                                                                                                        country: undefined | string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The country of the Tableau instance that is running the Extension.
-									The country is the ISO 3166 country string represented by the user specified language.
-								If the user specified lanugage is Français (Canada), country is CA.
                                                                                                                                        
-							
                                                                                                                                        
-							
                                                                                                                                        since
                                                                                                                                        
-							
                                                                                                                                        1.9.0 and Tableau 2022.2
-								If running against a Tableau version prior to 2022.2, country will be undefined.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        language
                                                                                                                                        
-					
                                                                                                                                        language: string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The language of the Tableau instance that is running the Extension.
-									The language is the ISO 639 language string of the user specified language.
-								If the user specified language is Français (Canada), language is fr.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        locale
                                                                                                                                        
-					
                                                                                                                                        locale: string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The OS locale of the environment in which the Extension is running.
-									Tableau Server supports both a language and a locale. This is the locale as
-									defined in RFC 5646 in lowercase.
-								If the user specified locale is English (United States), the locale is en-us.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        mode
                                                                                                                                        
-					
                                                                                                                                        mode: ExtensionMode
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        Current mode of the Extensions (i.e. authoring or viewing).
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        operatingSystem
                                                                                                                                        
-					
                                                                                                                                        operatingSystem: string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The OS in which Tableau is running.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        tableauVersion
                                                                                                                                        
-					
                                                                                                                                        tableauVersion: string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        The version of Tableau that is running the Extensions.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        Optional uniqueUserId
                                                                                                                                        
-					
                                                                                                                                        uniqueUserId: undefined | string
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        A unique id representing the current user.
-									The id is unique across a Tableau deployment or across a Tableau Cloud Site.
-									When the extension is running in desktop, the uniqueUserId is derived from machine-name/user-name.
-									When the extension is running in server, the uniqueUserId is derived from the user's login name.
-									There is no mechanism to obtain the actual user name or any additional user information.
-								If running against a Tableau version prior to 2023.2, uniqueUserId will be undefined.
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-				
                                                                                                                                        
-					
-					
                                                                                                                                        Optional workbookFormatting
                                                                                                                                        
-					
                                                                                                                                        workbookFormatting: WorkbookFormatting
                                                                                                                                        
-					
-					
                                                                                                                                        
-						
                                                                                                                                        
-							
                                                                                                                                        returns
                                                                                                                                        
-							
                                                                                                                                        WorkbookFormatting contains an array of FormattingSheets that will get
-									your formatting information from the workbook.
-									The types of sheet formatting by Class Name Key: WorksheetTitle, Worksheet (body text),
-									Tooltip, StoryTitle, and DashboardTitle
-									These formatting sheets include the following CSS properties: fontName, fontSize,
-								isFontBold, isFontItalic, isFontUnderlined, and color.
                                                                                                                                        
-							
                                                                                                                                        
-							
                                                                                                                                        since
                                                                                                                                        
-							
                                                                                                                                        1.7.0 and Tableau 2021.4
                                                                                                                                        
-							
                                                                                                                                        
-						
                                                                                                                                        
-					
                                                                                                                                        
-				
                                                                                                                                        
-			
                                                                                                                                        
-		
                                                                                                                                        
-		
                                                                                                                                        
-			
-			
-		
                                                                                                                                        
-	
                                                                                                                                        
-
                                                                                                                                        
-
                                                                                                                                        
-	
                                                                                                                                        
-		
                                                                                                                                        Legend
                                                                                                                                        
-		
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Module
                                                                                                                                          • 
-				
                                                                                                                                        • Object literal
                                                                                                                                          • 
-				
                                                                                                                                        • Variable
                                                                                                                                          • 
-				
                                                                                                                                        • Function
                                                                                                                                          • 
-				
                                                                                                                                        • Function with type parameter
                                                                                                                                          • 
-				
                                                                                                                                        • Index signature
                                                                                                                                          • 
-				
                                                                                                                                        • Type alias
                                                                                                                                          • 
-				
                                                                                                                                        • Type alias with type parameter
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Enumeration
                                                                                                                                          • 
-				
                                                                                                                                        • Enumeration member
                                                                                                                                          • 
-				
                                                                                                                                        • Property
                                                                                                                                          • 
-				
                                                                                                                                        • Method
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Interface
                                                                                                                                          • 
-				
                                                                                                                                        • Interface with type parameter
                                                                                                                                          • 
-				
                                                                                                                                        • Constructor
                                                                                                                                          • 
-				
                                                                                                                                        • Property
                                                                                                                                          • 
-				
                                                                                                                                        • Method
                                                                                                                                          • 
-				
                                                                                                                                        • Index signature
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Class
                                                                                                                                          • 
-				
                                                                                                                                        • Class with type parameter
                                                                                                                                          • 
-				
                                                                                                                                        • Constructor
                                                                                                                                          • 
-				
                                                                                                                                        • Property
                                                                                                                                          • 
-				
                                                                                                                                        • Method
                                                                                                                                          • 
-				
                                                                                                                                        • Accessor
                                                                                                                                          • 
-				
                                                                                                                                        • Index signature
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Inherited constructor
                                                                                                                                          • 
-				
                                                                                                                                        • Inherited property
                                                                                                                                          • 
-				
                                                                                                                                        • Inherited method
                                                                                                                                          • 
-				
                                                                                                                                        • Inherited accessor
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Protected property
                                                                                                                                          • 
-				
                                                                                                                                        • Protected method
                                                                                                                                          • 
-				
                                                                                                                                        • Protected accessor
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Private property
                                                                                                                                          • 
-				
                                                                                                                                        • Private method
                                                                                                                                          • 
-				
                                                                                                                                        • Private accessor
                                                                                                                                          • 
-			
                                                                                                                                        
-			
                                                                                                                                          
-				
                                                                                                                                        • Static property
                                                                                                                                          • 
-				
                                                                                                                                        • Static method
                                                                                                                                          • 
-			
                                                                                                                                        
-		
                                                                                                                                        
-	
                                                                                                                                        
-
                                                                                                                                        
-
                                                                                                                                        
-
-
-
-
-
\ No newline at end of file
+Environment | Tableau Extensions API
                                                                                                                                        Tableau Extensions API
                                                                                                                                          Preparing search index...
                                                                                                                                          Interface Environment
                                                                                                                                          The environment namespace provides a way to programmatically gather
+information about the environment in which the Extensions is running.
                                                                                                                                          
+
                                                                                                                                          interface Environment {
                                                                                                                                              apiVersion: string;
                                                                                                                                              context: ExtensionContext;
                                                                                                                                              country?: string;
                                                                                                                                              exportedMediaType?: ExportedMediaType;
                                                                                                                                              isExporting: boolean;
                                                                                                                                              language: string;
                                                                                                                                              locale: string;
                                                                                                                                              mode: ExtensionMode;
                                                                                                                                              operatingSystem: string;
                                                                                                                                              tableauVersion: string;
                                                                                                                                              uniqueUserId?: string;
                                                                                                                                              workbookFormatting?: WorkbookFormatting;
                                                                                                                                              workbookLocale: string;
                                                                                                                                          }
                                                                                                                                          Index
                                                                                                                                          Properties
                                                                                                                                          apiVersion
+context
+country?
+exportedMediaType?
+isExporting
+language
+locale
+mode
+operatingSystem
+tableauVersion
+uniqueUserId?
+workbookFormatting?
+workbookLocale
+
                                                                                                                                          Properties
                                                                                                                                          apiVersion: string
                                                                                                                                          The version of the API being used by the Extensions.
                                                                                                                                          
+
                                                                                                                                          context: ExtensionContext
                                                                                                                                          Current context in which the Extensions is running (i.e. Desktop or Server).
                                                                                                                                          
+
                                                                                                                                          country?: string
                                                                                                                                          The country of the Tableau instance that is running the Extension.
+The country is the ISO 3166 country string represented by the user specified language.
+If the user specified lanugage is Français (Canada), country is CA.
                                                                                                                                          
+
                                                                                                                                          1.9.0 and Tableau 2022.2
+If running against a Tableau version prior to 2022.2, country will be undefined.
                                                                                                                                          
+
                                                                                                                                          exportedMediaType?: ExportedMediaType
                                                                                                                                          The media type of the exported content if the extension is running in exporting mode, undefined otherwise.
                                                                                                                                          
+
                                                                                                                                          isExporting: boolean
                                                                                                                                          True if the extension is running in exporting mode, false otherwise.
                                                                                                                                          
+
                                                                                                                                          language: string
                                                                                                                                          The language of the Tableau instance that is running the Extension.
+The language is the ISO 639 language string of the user specified language.
+If the user specified language is Français (Canada), language is fr.
                                                                                                                                          
+
                                                                                                                                          locale: string
                                                                                                                                          The OS locale of the environment in which the Extension is running.
+Tableau Server supports both a language and a locale. This is the locale as
+defined in RFC 5646 in lowercase.
+If the user specified locale is English (United States), the locale is en-us.
                                                                                                                                          
+
                                                                                                                                          mode: ExtensionMode
                                                                                                                                          Current mode of the Extensions (i.e. authoring or viewing).
                                                                                                                                          
+
                                                                                                                                          operatingSystem: string
                                                                                                                                          The OS in which Tableau is running.
                                                                                                                                          
+
                                                                                                                                          tableauVersion: string
                                                                                                                                          The version of Tableau that is running the Extensions.
                                                                                                                                          
+
                                                                                                                                          uniqueUserId?: string
                                                                                                                                          A unique id representing the current user.
+The id is unique across a Tableau deployment or across a Tableau Cloud Site.
+When the extension is running in desktop, the uniqueUserId is derived from machine-name/user-name.
+When the extension is running in server, the uniqueUserId is derived from the user's login name.
+There is no mechanism to obtain the actual user name or any additional user information.
+If running against a Tableau version prior to 2023.2, uniqueUserId will be undefined.
                                                                                                                                          
+
                                                                                                                                          workbookFormatting?: WorkbookFormatting
                                                                                                                                          WorkbookFormatting contains an array of FormattingSheets that will get
+your formatting information from the workbook.
+The types of sheet formatting by Class Name Key: WorksheetTitle, Worksheet (body text),
+Tooltip, StoryTitle, and DashboardTitle
+These formatting sheets include the following CSS properties: fontName, fontSize,
+isFontBold, isFontItalic, isFontUnderlined, and color.
                                                                                                                                          
+
                                                                                                                                          1.7.0 and Tableau 2021.4
                                                                                                                                          
+
                                                                                                                                          workbookLocale: string
                                                                                                                                          The locale of the workbook.
+This is the locale as defined in RFC 5646 in lowercase.
+If the user specified locale is English (United States), the locale is en-us.
                                                                                                                                          
+
                                                                                                                                          1.16.0
                                                                                                                                          
+
                                                                                                                                          Settings
                                                                                                                                          Member Visibility
                                                                                                                                          On This Page
                                                                                                                                          Properties
                                                                                                                                          
diff --git a/website/static/api/interfaces/eventlistenermanager.html b/website/static/api/interfaces/eventlistenermanager.html
index 1d7f2a01..a0cd1fd5 100644
--- a/website/static/api/interfaces/eventlistenermanager.html
+++ b/website/static/api/interfaces/eventlistenermanager.html
@@ -1,329 +1,72 @@
-
-
-
-	
-	
-	EventListenerManager | Tableau Extensions
-	
-	
-	
-
-
-
                                                                                                                                          
-	
                                                                                                                                          
-		
                                                                                                                                          
-			
                                                                                                                                          
-				
-				
                                                                                                                                          
-					
                                                                                                                                          
-						Options
-						
                                                                                                                                          
-							
                                                                                                                                          
-								All
-								
                                                                                                                                            
-									
                                                                                                                                          • Public
                                                                                                                                            • 
-									
                                                                                                                                          • Public/Protected
                                                                                                                                            • 
-									
                                                                                                                                          • All
                                                                                                                                            • 
-								
                                                                                                                                          
-							
                                                                                                                                          
-							
-							
-							
-							
-						
                                                                                                                                          
-					
                                                                                                                                          
-					Menu
-				
                                                                                                                                          
-			
                                                                                                                                          
-		
                                                                                                                                          
-	
                                                                                                                                          
-	
                                                                                                                                          
-		
                                                                                                                                          
-			
-			
                                                                                                                                          Interface EventListenerManager
                                                                                                                                          
-		
                                                                                                                                          
-	
                                                                                                                                          
-
                                                                                                                                          
-
                                                                                                                                          
-	
                                                                                                                                          
-		
                                                                                                                                          
-			
                                                                                                                                          
-				
                                                                                                                                          
-					
                                                                                                                                          
-						
                                                                                                                                          Interface for handling registering and unregistering event listeners. Different objects will implement
-						this interface to manage their event handling.
                                                                                                                                          
-					
                                                                                                                                          
-				
                                                                                                                                          
-			
                                                                                                                                          
-			
                                                                                                                                          
-				
                                                                                                                                          Hierarchy
                                                                                                                                          
-				
-			
                                                                                                                                          
-			
                                                                                                                                          
-				
                                                                                                                                          Index
                                                                                                                                          
-				
                                                                                                                                          
-					
                                                                                                                                          
-						
                                                                                                                                          
-							
                                                                                                                                          Methods
                                                                                                                                          
-							
-						
                                                                                                                                          
-					
                                                                                                                                          
-				
                                                                                                                                          
-			
                                                                                                                                          
-			
                                                                                                                                          
-				
                                                                                                                                          Methods
                                                                                                                                          
-				
                                                                                                                                          
-					
-					
                                                                                                                                          addEventListener
                                                                                                                                          
-					
-					
                                                                                                                                            
-						
                                                                                                                                          • 
-							
-							
                                                                                                                                            
-								
                                                                                                                                            
-									
                                                                                                                                            Adds a new event listener to the object. If this object does not support the specified eventType,
-										the method throws an exception.
-									The following table shows the event types supported by objects.
                                                                                                                                            
-								
                                                                                                                                            
-								
-									
-										
-											
-											
-										
-									
-									
-											
-											
-										
-										
-											
-											
-										
-										
-											
-											
-										
-										
-											
-											
-										
-								
                                                                                                                                            objecteventType
                                                                                                                                            WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                            ParameterParameterChanged
                                                                                                                                            SettingsSettingsChanged
                                                                                                                                            DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                            
-							
                                                                                                                                            
-							
                                                                                                                                            Parameters
                                                                                                                                            
-							
                                                                                                                                              
-								
                                                                                                                                            • 
-									
                                                                                                                                              eventType: TableauEventType
                                                                                                                                              
-									
                                                                                                                                              
-										
                                                                                                                                              The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                                              
-									
                                                                                                                                              
-								
                                                                                                                                              • 
-								
                                                                                                                                            • 
-									
                                                                                                                                              handler: TableauEventHandlerFn
                                                                                                                                              
-									
                                                                                                                                              
-										
                                                                                                                                              The function which will be called when an event happens.
                                                                                                                                              
-									
                                                                                                                                              
-								
                                                                                                                                              • 
-							
                                                                                                                                            
-							
                                                                                                                                            Returns TableauEventUnregisterFn
                                                                                                                                            
-							
                                                                                                                                            A helper function which can be called to remove this registration.
                                                                                                                                            
-							
                                                                                                                                            The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
-								When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
-							the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                                            
-							
                                                                                                                                            // Add an event listener for the selection changed event on this sheet.
-// Assigning the event to a variable just to make the example fit on the page here.
-const markSelection = tableau.TableauEventType.MarkSelectionChanged;
-//
-unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
-// When the selection changes, reload the data
-loadSelectedMarks(worksheetName);
-});
+EventListenerManager | Tableau Extensions API
                                                                                                                                            Tableau Extensions API
                                                                                                                                              Preparing search index...
                                                                                                                                              Interface EventListenerManager
                                                                                                                                              Interface for handling registering and unregistering event listeners. Different objects will implement
+this interface to manage their event handling.
                                                                                                                                              
+
                                                                                                                                              interface EventListenerManager {
                                                                                                                                                  addEventListener(
                                                                                                                                                      eventType: TableauEventType,
                                                                                                                                                      handler: TableauEventHandlerFn,
                                                                                                                                                  ): TableauEventUnregisterFn;
                                                                                                                                                  removeEventListener(
                                                                                                                                                      eventType: TableauEventType,
                                                                                                                                                      handler: TableauEventHandlerFn,
                                                                                                                                                  ): boolean;
                                                                                                                                              }
                                                                                                                                              Hierarchy (View Summary)
                                                                                                                                              Index
                                                                                                                                              Methods
                                                                                                                                              addEventListener
+removeEventListener
+
                                                                                                                                              Methods
                                                                                                                                              • Adds a new event listener to the object. If this object does not support the specified eventType,
+the method throws an exception.
+The following table shows the event types supported by objects.
                                                                                                                                                
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                objecteventType
                                                                                                                                                WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                ParameterParameterChanged
                                                                                                                                                SettingsSettingsChanged
                                                                                                                                                DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                
+
                                                                                                                                                Parameters
                                                                                                                                                • eventType: TableauEventType
                                                                                                                                                  The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                                                  
+
                                                                                                                                                • handler: TableauEventHandlerFn
                                                                                                                                                  The function which will be called when an event happens.
                                                                                                                                                  
+
                                                                                                                                                Returns TableauEventUnregisterFn
                                                                                                                                                A helper function which can be called to remove this registration.
                                                                                                                                                
+
                                                                                                                                                The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
+When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
+the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                                                
+
                                                                                                                                                // Add an event listener for the selection changed event on this sheet.
                                                                                                                                                // Assigning the event to a variable just to make the example fit on the page here.
                                                                                                                                                 const markSelection = tableau.TableauEventType.MarkSelectionChanged;
                                                                                                                                                  //
                                                                                                                                                 unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
                                                                                                                                                 // When the selection changes, reload the data
                                                                                                                                                     loadSelectedMarks(worksheetName);
                                                                                                                                                 });

                                                                                                                                                // remove the event listener when done
                                                                                                                                                 unregisterEventHandlerFunction();
                                                                                                                                                
+
                                                                                                                                                
 
-// remove the event listener when done
- unregisterEventHandlerFunction();
-
                                                                                                                                              
-						
                                                                                                                                              • 
-					
                                                                                                                                            
-				
                                                                                                                                            
-				
                                                                                                                                            
-					
-					
                                                                                                                                            removeEventListener
                                                                                                                                            
-					
-					
                                                                                                                                              
-						
                                                                                                                                            • 
-							
-							
                                                                                                                                              
-								
                                                                                                                                              
-									
                                                                                                                                              Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing.
-										The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function
-										returned from the call to addEventListener to unregister the event listener.
-									For more information, see Events and Event Handling.
                                                                                                                                              
-								
                                                                                                                                              
-							
                                                                                                                                              
-							
                                                                                                                                              Parameters
                                                                                                                                              
-							
-							
                                                                                                                                              Returns boolean
                                                                                                                                              
-							
                                                                                                                                              Whether or not an event listener was removed.
                                                                                                                                              
-						
                                                                                                                                              • 
-					
                                                                                                                                            
-				
                                                                                                                                            
-			
                                                                                                                                            
-		
                                                                                                                                            
-		
                                                                                                                                            
-			
-			
-		
                                                                                                                                            
-	
                                                                                                                                            
-
                                                                                                                                            
-
                                                                                                                                            
-	
                                                                                                                                            
-		
                                                                                                                                            Legend
                                                                                                                                            
-		
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Module
                                                                                                                                              • 
-				
                                                                                                                                            • Object literal
                                                                                                                                              • 
-				
                                                                                                                                            • Variable
                                                                                                                                              • 
-				
                                                                                                                                            • Function
                                                                                                                                              • 
-				
                                                                                                                                            • Function with type parameter
                                                                                                                                              • 
-				
                                                                                                                                            • Index signature
                                                                                                                                              • 
-				
                                                                                                                                            • Type alias
                                                                                                                                              • 
-				
                                                                                                                                            • Type alias with type parameter
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Enumeration
                                                                                                                                              • 
-				
                                                                                                                                            • Enumeration member
                                                                                                                                              • 
-				
                                                                                                                                            • Property
                                                                                                                                              • 
-				
                                                                                                                                            • Method
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Interface
                                                                                                                                              • 
-				
                                                                                                                                            • Interface with type parameter
                                                                                                                                              • 
-				
                                                                                                                                            • Constructor
                                                                                                                                              • 
-				
                                                                                                                                            • Property
                                                                                                                                              • 
-				
                                                                                                                                            • Method
                                                                                                                                              • 
-				
                                                                                                                                            • Index signature
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Class
                                                                                                                                              • 
-				
                                                                                                                                            • Class with type parameter
                                                                                                                                              • 
-				
                                                                                                                                            • Constructor
                                                                                                                                              • 
-				
                                                                                                                                            • Property
                                                                                                                                              • 
-				
                                                                                                                                            • Method
                                                                                                                                              • 
-				
                                                                                                                                            • Accessor
                                                                                                                                              • 
-				
                                                                                                                                            • Index signature
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Inherited constructor
                                                                                                                                              • 
-				
                                                                                                                                            • Inherited property
                                                                                                                                              • 
-				
                                                                                                                                            • Inherited method
                                                                                                                                              • 
-				
                                                                                                                                            • Inherited accessor
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Protected property
                                                                                                                                              • 
-				
                                                                                                                                            • Protected method
                                                                                                                                              • 
-				
                                                                                                                                            • Protected accessor
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Private property
                                                                                                                                              • 
-				
                                                                                                                                            • Private method
                                                                                                                                              • 
-				
                                                                                                                                            • Private accessor
                                                                                                                                              • 
-			
                                                                                                                                            
-			
                                                                                                                                              
-				
                                                                                                                                            • Static property
                                                                                                                                              • 
-				
                                                                                                                                            • Static method
                                                                                                                                              • 
-			
                                                                                                                                            
-		
                                                                                                                                            
-	
                                                                                                                                            
-
                                                                                                                                            
-
                                                                                                                                            
-
-
-
-
-
\ No newline at end of file
+

                                                                                                                                        • Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function +returned from the call to addEventListener to unregister the event listener. +For more information, see Events and Event Handling.

                                                                                                                                          +

                                                                                                                                          Parameters

                                                                                                                                          Returns boolean

                                                                                                                                          Whether or not an event listener was removed.

                                                                                                                                          +

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Methods
                                                                                                                                        diff --git a/website/static/api/interfaces/extensions.html b/website/static/api/interfaces/extensions.html index 71761450..5c995903 100644 --- a/website/static/api/interfaces/extensions.html +++ b/website/static/api/interfaces/extensions.html @@ -1,576 +1,110 @@ - - - - - - Extensions | Tableau Extensions - - - - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - Options -
                                                                                                                                        -
                                                                                                                                        - All -
                                                                                                                                          -
                                                                                                                                        • Public
                                                                                                                                          • -
                                                                                                                                        • Public/Protected
                                                                                                                                          • -
                                                                                                                                        • All
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        - - - - -
                                                                                                                                        -
                                                                                                                                        - Menu -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        Interface Extensions

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The extension namespace contains all functionality available to - Extensions in Tableau.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Hierarchy

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - Extensions -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Index

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        All Extensions Properties

                                                                                                                                        - -

                                                                                                                                        Dashboard Extensions Properties

                                                                                                                                        - -

                                                                                                                                        Viz Extensions Properties

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        All Extensions Methods

                                                                                                                                        - -

                                                                                                                                        Dashboard Extensions Methods

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        All Extensions Properties

                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        environment

                                                                                                                                        -
                                                                                                                                        environment: Environment
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The environment namespace provides methods to programmatically gather information about the environment - in which the extension is running. To access the objects in this name space, specify - tableau.extensions.environment.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        settings

                                                                                                                                        -
                                                                                                                                        settings: Settings
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The settings namespace provides methods to get and set values which will be persisted in a workbook. - You can use the settings to configure an extension. To access the objects in this name space, specify - tableau.extensions.settings.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        ui

                                                                                                                                        -
                                                                                                                                        ui: UI
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The ui namespace provides methods for an extension to display a popup dialog window. - To access the objects in this name space, specify tableau.extensions.ui.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        workbook

                                                                                                                                        -
                                                                                                                                        workbook: Workbook
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The currently opened workbook.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        since
                                                                                                                                        -

                                                                                                                                        1.6.0 and Tableau 2021.3

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Dashboard Extensions Properties

                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        Optional dashboardContent

                                                                                                                                        -
                                                                                                                                        dashboardContent: DashboardContent
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The dashboardContent namespace provides access to the dashboard object when the extension is a dashboard extension. - When you have the dashboard object, you have access to all elements in the dashboard - including the worksheets, marks, - filters, parameters, and data sources. - To access the objects in this name space, specify tableau.extensions.dashboardContent.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        dashboardObjectId

                                                                                                                                        -
                                                                                                                                        dashboardObjectId: number
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The dashboard object id for the extension that is running.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        since
                                                                                                                                        -

                                                                                                                                        1.7.0

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Viz Extensions Properties

                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        Optional worksheetContent

                                                                                                                                        -
                                                                                                                                        worksheetContent: WorksheetContent
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        The worksheetContent namespace provides access to the worksheet when the extension is a worksheet extension. - When you have the worksheet object, you have access to all elements in the worksheet - To access the objects in this name space, specify tableau.extensions.worksheetContent.

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        since
                                                                                                                                        -

                                                                                                                                        1.12.0 and Tableau 2024.2

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        All Extensions Methods

                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        createVizImageAsync

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • createVizImageAsync(inputSpec: object): Promise<string>
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          since
                                                                                                                                          -

                                                                                                                                          1.8.0 and Tableau 2021.4

                                                                                                                                          -

                                                                                                                                          For additional information on using the createVizImageAsync method, - see Add Tableau Viz to Your Dashboard Extensions.

                                                                                                                                          -

                                                                                                                                          For additional information about setting options in the inputSpec object, - see Tableau Viz Reference.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Parameters

                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • -
                                                                                                                                            inputSpec: object
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            the object containing the embedded data and visual spec details

                                                                                                                                            - 
                                                                                                                                               tableau.extensions.createVizImageAsync(myInputSpec));

                                                                                                                                            The following is an example of an input spec object.

                                                                                                                                            - 
                                                                                                                                            var myInputSpec = {
-      description: 'A simple bar chart with embedded data.',
-      data: {
-          values: [
-              { Category: 'A', Measure: 28, Weather: 10 },
-              { Category: 'B', Measure: 55, Weather: 9 },
-              { Category: 'C', Measure: 43, Weather: 8 },
-          ]
-      },
-      mark: tableau.MarkType.Bar,
-      encoding: {
-          columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete },
-          rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous },
-          sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending }
-      }
- };
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            • -
                                                                                                                                          -

                                                                                                                                          Returns Promise<string>

                                                                                                                                          -

                                                                                                                                          A promise that when resolved, returns the viz as an svg.

                                                                                                                                          -

                                                                                                                                          Supports sorting by field.

                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        initializeAsync

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • initializeAsync(contextMenuCallbacks?: undefined | {}): Promise<void>
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          This is the entry point for an Extension. This function must first be called - in order to interact with any of the other Extension APIs.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Parameters

                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • -
                                                                                                                                            Optional contextMenuCallbacks: undefined | {}
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            This optional object maps the ids of context menu items to the function - to be triggered when that context menu item is selected. The keys listed - must matched the keys registered in the context-menu element of the manifest. - Currently, only a single context menu item is available ('configure') - that creates the Configure... menu item), so this object will only contain a single entry. - In this example, the 'configure' key is mapped to a function of the same name, - which you would define in your JavaScript code.

                                                                                                                                            - 
                                                                                                                                              $(document).ready(function () {
-    tableau.extensions.initializeAsync({'configure': configure}).then(function() {
-    // When the user clicks the Configure... context menu item,
-    // the configure function specified as the argument here
-    // is executed.
-    //
-   });
-  });
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            • -
                                                                                                                                          -

                                                                                                                                          Returns Promise<void>

                                                                                                                                          -

                                                                                                                                          A promise that when resolved, the other Extension APIs will be available to use.

                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        initializeDialogAsync

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • initializeDialogAsync(): Promise<string>
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          The initializeDialogAsync function is the entry point for an extension that runs inside a dialog box (or popup window) - created by the UI namespace. A call to tableau.extensions.ui.displayDialogAsync(payload) creates the dialog box. - When the extension running in the dialog box loads, the extension must first call the initializeDialogAsync function - to use the rest of the Extension API. The initializeDialogAsync function should only be called by extensions - that are displayed in a dialog box. You use the initializeAsync function - to initialize the main extension, that is, the parent of the extension in the dialog box.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Returns Promise<string>

                                                                                                                                          -

                                                                                                                                          A promise that when resolved the other Extension APIs will be available to use. - Contains a string that is the initial payload for the dialog as sent by the - parent extension via tableau.extensions.ui.displayDialogAsync(payload). - See displayDialogAsync for more information.

                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Dashboard Extensions Methods

                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        setClickThroughAsync

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • setClickThroughAsync(clickThroughEnabled: boolean): Promise<void>
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          This method allows for clicks to pass through the extension window on Tableau Server.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          since
                                                                                                                                          -

                                                                                                                                          1.7.0 and Tableau 2021.4

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Parameters

                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • -
                                                                                                                                            clickThroughEnabled: boolean
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            A boolean which represents if clicks should pass through the extension window

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            • -
                                                                                                                                          -

                                                                                                                                          Returns Promise<void>

                                                                                                                                          -

                                                                                                                                          A promise that resolves when the click through property has been set.

                                                                                                                                          -

                                                                                                                                          The following example shows a call made to setClickThroughAsync.

                                                                                                                                          - 
                                                                                                                                             // disabling pointer events on the extension window
-   tableau.extensions.setClickThroughAsync(true).then(() => {
-    console.log('Successfully enabled extension window click through');
-   }).catch((error) => {
-    // Can throw an error if called from a dialog or on Tableau Desktop
-      console.error(error.message);
-    });
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Legend

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Module
                                                                                                                                          • -
                                                                                                                                        • Object literal
                                                                                                                                          • -
                                                                                                                                        • Variable
                                                                                                                                          • -
                                                                                                                                        • Function
                                                                                                                                          • -
                                                                                                                                        • Function with type parameter
                                                                                                                                          • -
                                                                                                                                        • Index signature
                                                                                                                                          • -
                                                                                                                                        • Type alias
                                                                                                                                          • -
                                                                                                                                        • Type alias with type parameter
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Enumeration
                                                                                                                                          • -
                                                                                                                                        • Enumeration member
                                                                                                                                          • -
                                                                                                                                        • Property
                                                                                                                                          • -
                                                                                                                                        • Method
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Interface
                                                                                                                                          • -
                                                                                                                                        • Interface with type parameter
                                                                                                                                          • -
                                                                                                                                        • Constructor
                                                                                                                                          • -
                                                                                                                                        • Property
                                                                                                                                          • -
                                                                                                                                        • Method
                                                                                                                                          • -
                                                                                                                                        • Index signature
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Class
                                                                                                                                          • -
                                                                                                                                        • Class with type parameter
                                                                                                                                          • -
                                                                                                                                        • Constructor
                                                                                                                                          • -
                                                                                                                                        • Property
                                                                                                                                          • -
                                                                                                                                        • Method
                                                                                                                                          • -
                                                                                                                                        • Accessor
                                                                                                                                          • -
                                                                                                                                        • Index signature
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Inherited constructor
                                                                                                                                          • -
                                                                                                                                        • Inherited property
                                                                                                                                          • -
                                                                                                                                        • Inherited method
                                                                                                                                          • -
                                                                                                                                        • Inherited accessor
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Protected property
                                                                                                                                          • -
                                                                                                                                        • Protected method
                                                                                                                                          • -
                                                                                                                                        • Protected accessor
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Private property
                                                                                                                                          • -
                                                                                                                                        • Private method
                                                                                                                                          • -
                                                                                                                                        • Private accessor
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Static property
                                                                                                                                          • -
                                                                                                                                        • Static method
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -Extensions | Tableau Extensions API
                                                                                                                                        Tableau Extensions API
                                                                                                                                          Preparing search index...

                                                                                                                                          Interface Extensions

                                                                                                                                          The extension namespace contains all functionality available to +Extensions in Tableau.

                                                                                                                                          +
                                                                                                                                          interface Extensions {
                                                                                                                                              dashboardContent?: DashboardContent;
                                                                                                                                              dashboardObjectId: number;
                                                                                                                                              environment: Environment;
                                                                                                                                              settings: Settings;
                                                                                                                                              ui: UI;
                                                                                                                                              workbook: Workbook;
                                                                                                                                              worksheetContent?: WorksheetContent;
                                                                                                                                              createVizImageAsync(inputSpec: object): Promise<string>;
                                                                                                                                              initializeAsync(
                                                                                                                                                  contextMenuCallbacks?: { [key: string]: () => {} },
                                                                                                                                              ): Promise<void>;
                                                                                                                                              initializeDialogAsync(): Promise<string>;
                                                                                                                                              reportExtensionRenderComplete(mediaBlob?: ArrayBuffer): Promise<void>;
                                                                                                                                              setClickThroughAsync(clickThroughEnabled: boolean): Promise<void>;
                                                                                                                                          }
                                                                                                                                          Index

                                                                                                                                          Properties - All Extensions

                                                                                                                                          environment +settings +ui +workbook +

                                                                                                                                          Properties - Dashboard Extensions

                                                                                                                                          dashboardContent? +dashboardObjectId +

                                                                                                                                          Properties - Viz Extensions

                                                                                                                                          worksheetContent? +

                                                                                                                                          Methods - All Extensions

                                                                                                                                          createVizImageAsync +initializeAsync +initializeDialogAsync +reportExtensionRenderComplete +

                                                                                                                                          Methods - Dashboard Extensions

                                                                                                                                          setClickThroughAsync +

                                                                                                                                          Properties - All Extensions

                                                                                                                                          environment: Environment

                                                                                                                                          The environment namespace provides methods to programmatically gather information about the environment +in which the extension is running. To access the objects in this name space, specify +tableau.extensions.environment.

                                                                                                                                          +
                                                                                                                                          settings: Settings

                                                                                                                                          The settings namespace provides methods to get and set values which will be persisted in a workbook. +You can use the settings to configure an extension. To access the objects in this name space, specify +tableau.extensions.settings.

                                                                                                                                          +
                                                                                                                                          ui: UI

                                                                                                                                          The ui namespace provides methods for an extension to display a popup dialog window. +To access the objects in this name space, specify tableau.extensions.ui.

                                                                                                                                          +
                                                                                                                                          workbook: Workbook

                                                                                                                                          The currently opened workbook.

                                                                                                                                          +

                                                                                                                                          1.6.0 and Tableau 2021.3

                                                                                                                                          +

                                                                                                                                          Properties - Dashboard Extensions

                                                                                                                                          dashboardContent?: DashboardContent

                                                                                                                                          The dashboardContent namespace provides access to the dashboard object when the extension is a dashboard extension. +When you have the dashboard object, you have access to all elements in the dashboard +including the worksheets, marks, +filters, parameters, and data sources. +To access the objects in this name space, specify tableau.extensions.dashboardContent.

                                                                                                                                          +
                                                                                                                                          dashboardObjectId: number

                                                                                                                                          The dashboard object id for the extension that is running.

                                                                                                                                          +

                                                                                                                                          1.7.0

                                                                                                                                          +

                                                                                                                                          Properties - Viz Extensions

                                                                                                                                          worksheetContent?: WorksheetContent

                                                                                                                                          The worksheetContent namespace provides access to the worksheet when the extension is a worksheet extension. +When you have the worksheet object, you have access to all elements in the worksheet +To access the objects in this name space, specify tableau.extensions.worksheetContent.

                                                                                                                                          +

                                                                                                                                          1.12.0 and Tableau 2024.2

                                                                                                                                          +

                                                                                                                                          Methods - All Extensions

                                                                                                                                          • Parameters

                                                                                                                                            • inputSpec: object

                                                                                                                                              the object containing the embedded data and visual spec details

                                                                                                                                              +
                                                                                                                                                 tableau.extensions.createVizImageAsync(myInputSpec));
+
                                                                                                                                              - ga('create', '469571326', 'auto'); - ga('send', 'pageview'); - - - \ No newline at end of file +

                                                                                                                                              The following is an example of an input spec object.

                                                                                                                                              +
                                                                                                                                              var myInputSpec = {
                                                                                                                                                    description: 'A simple bar chart with embedded data.',
                                                                                                                                                    data: {
                                                                                                                                                        values: [
                                                                                                                                                            { Category: 'A', Measure: 28, Weather: 10 },
                                                                                                                                                            { Category: 'B', Measure: 55, Weather: 9 },
                                                                                                                                                            { Category: 'C', Measure: 43, Weather: 8 },
                                                                                                                                                        ]
                                                                                                                                                    },
                                                                                                                                                    mark: tableau.MarkType.Bar,
                                                                                                                                                    encoding: {
                                                                                                                                                        columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete },
                                                                                                                                                        rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous },
                                                                                                                                                        sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending }
                                                                                                                                                    }
                                                                                                                                               };
+
                                                                                                                                              + +

                                                                                                                                            Returns Promise<string>

                                                                                                                                            A promise that when resolved, returns the viz as an svg.

                                                                                                                                            +

                                                                                                                                            Supports sorting by field.

                                                                                                                                            +

                                                                                                                                            1.8.0 and Tableau 2021.4

                                                                                                                                            +

                                                                                                                                            For additional information on using the createVizImageAsync method, +see Add Tableau Viz to Your Dashboard Extensions.

                                                                                                                                            +

                                                                                                                                            For additional information about setting options in the inputSpec object, +see Tableau Viz Reference.

                                                                                                                                            +

                                                                                                                                          • This is the entry point for an Extension. This function must first be called +in order to interact with any of the other Extension APIs.

                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            • OptionalcontextMenuCallbacks: { [key: string]: () => {} }

                                                                                                                                              This optional object maps the ids of context menu items to the function +to be triggered when that context menu item is selected. The keys listed +must matched the keys registered in the context-menu element of the manifest. +Currently, only a single context menu item is available ('configure') +that creates the Configure... menu item), so this object will only contain a single entry. +In this example, the 'configure' key is mapped to a function of the same name, +which you would define in your JavaScript code.

                                                                                                                                              +
                                                                                                                                               $(document).ready(function () {
                                                                                                                                                 tableau.extensions.initializeAsync({'configure': configure}).then(function() {
                                                                                                                                                 // When the user clicks the Configure... context menu item,
                                                                                                                                                 // the configure function specified as the argument here
                                                                                                                                                 // is executed.
                                                                                                                                                 //
                                                                                                                                                });
                                                                                                                                               });
+
                                                                                                                                              + +

                                                                                                                                            Returns Promise<void>

                                                                                                                                            A promise that when resolved, the other Extension APIs will be available to use.

                                                                                                                                            +

                                                                                                                                          • The initializeDialogAsync function is the entry point for an extension that runs inside a dialog box (or popup window) +created by the UI namespace. A call to tableau.extensions.ui.displayDialogAsync(payload) creates the dialog box. +When the extension running in the dialog box loads, the extension must first call the initializeDialogAsync function +to use the rest of the Extension API. The initializeDialogAsync function should only be called by extensions +that are displayed in a dialog box. You use the initializeAsync function +to initialize the main extension, that is, the parent of the extension in the dialog box.

                                                                                                                                            +

                                                                                                                                            Returns Promise<string>

                                                                                                                                            A promise that when resolved the other Extension APIs will be available to use. +Contains a string that is the initial payload for the dialog as sent by the +parent extension via tableau.extensions.ui.displayDialogAsync(payload). +See displayDialogAsync for more information.

                                                                                                                                            +

                                                                                                                                          • This method notifies the platform that the extension has completed its rendering. +This can be used to signal that the extension is ready for interaction or for exporting.

                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            • OptionalmediaBlob: ArrayBuffer

                                                                                                                                              An optional blob of media data to be included in the rendering complete notification (e.g. an image).

                                                                                                                                              +

                                                                                                                                            Returns Promise<void>

                                                                                                                                            1.17.0 and Tableau 2026.2

                                                                                                                                            +

                                                                                                                                          Methods - Dashboard Extensions

                                                                                                                                          • This method allows for clicks to pass through the extension window on Tableau Server.

                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            • clickThroughEnabled: boolean

                                                                                                                                              A boolean which represents if clicks should pass through the extension window

                                                                                                                                              +

                                                                                                                                            Returns Promise<void>

                                                                                                                                            A promise that resolves when the click through property has been set.

                                                                                                                                            +

                                                                                                                                            The following example shows a call made to setClickThroughAsync.

                                                                                                                                            +
                                                                                                                                               // disabling pointer events on the extension window
                                                                                                                                               tableau.extensions.setClickThroughAsync(true).then(() => {
                                                                                                                                                console.log('Successfully enabled extension window click through');
                                                                                                                                               }).catch((error) => {
                                                                                                                                                // Can throw an error if called from a dialog or on Tableau Desktop
                                                                                                                                                  console.error(error.message);
                                                                                                                                                });
+
                                                                                                                                            + +

                                                                                                                                            1.7.0 and Tableau 2021.4

                                                                                                                                            +

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Properties - All Extensions
                                                                                                                                          Properties - Dashboard Extensions
                                                                                                                                          Properties - Viz Extensions
                                                                                                                                          Methods - All Extensions
                                                                                                                                          Methods - Dashboard Extensions
                                                                                                                                          diff --git a/website/static/api/interfaces/field.html b/website/static/api/interfaces/field.html index b8300bb2..7b45d1c2 100644 --- a/website/static/api/interfaces/field.html +++ b/website/static/api/interfaces/field.html @@ -1,511 +1,66 @@ - - - - - - Field | Tableau Extensions - - - - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - Options -
                                                                                                                                          -
                                                                                                                                          - All -
                                                                                                                                            -
                                                                                                                                          • Public
                                                                                                                                            • -
                                                                                                                                          • Public/Protected
                                                                                                                                            • -
                                                                                                                                          • All
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                          - - - - -
                                                                                                                                          -
                                                                                                                                          - Menu -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          Interface Field

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          A field contains information about what data source it belongs to, - its role, and the ability to fetch the domain values.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Hierarchy

                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • - FieldBase -
                                                                                                                                              -
                                                                                                                                            • - Field -
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Index

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Properties

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Properties

                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          aggregation

                                                                                                                                          -
                                                                                                                                          aggregation: FieldAggregationType
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The type of aggregation for this field.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          columnType

                                                                                                                                          -
                                                                                                                                          columnType: ColumnType
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The type of the column, either discrete or continuous. Could hold value 'Unknown'.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          dataSource

                                                                                                                                          -
                                                                                                                                          dataSource: DataSource
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The data source to which this field belongs.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          dataType

                                                                                                                                          -
                                                                                                                                          dataType: DataType | undefined
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The data type of the field

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          description

                                                                                                                                          -
                                                                                                                                          description: string | undefined
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          User description of field, undefined if there is none.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          id

                                                                                                                                          -
                                                                                                                                          id: string
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          Unique string representing this field in this datasource.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isCalculatedField

                                                                                                                                          -
                                                                                                                                          isCalculatedField: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this field is a table calculation.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isCombinedField

                                                                                                                                          -
                                                                                                                                          isCombinedField: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this field is a combination of multiple fields, false otherwise.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isGenerated

                                                                                                                                          -
                                                                                                                                          isGenerated: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this field is generated by Tableau, false otherwise. - Tableau generates a number of fields for a data source, such as Number - of Records, or Measure Values. This property can be used to - distinguish between those fields and fields that come from the underlying - data connection, or were created by a user.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isGeospatial

                                                                                                                                          -
                                                                                                                                          isGeospatial: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name...

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isHidden

                                                                                                                                          -
                                                                                                                                          isHidden: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this field is hidden, false otherwise.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          isPresentOnPublishedDatasource

                                                                                                                                          -
                                                                                                                                          isPresentOnPublishedDatasource: boolean
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example).

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          name

                                                                                                                                          -
                                                                                                                                          name: string
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The name of the field (i.e. the caption).

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          role

                                                                                                                                          -
                                                                                                                                          role: FieldRoleType
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          returns
                                                                                                                                          -

                                                                                                                                          The role of this field.

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Legend

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Module
                                                                                                                                            • -
                                                                                                                                          • Object literal
                                                                                                                                            • -
                                                                                                                                          • Variable
                                                                                                                                            • -
                                                                                                                                          • Function
                                                                                                                                            • -
                                                                                                                                          • Function with type parameter
                                                                                                                                            • -
                                                                                                                                          • Index signature
                                                                                                                                            • -
                                                                                                                                          • Type alias
                                                                                                                                            • -
                                                                                                                                          • Type alias with type parameter
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Enumeration
                                                                                                                                            • -
                                                                                                                                          • Enumeration member
                                                                                                                                            • -
                                                                                                                                          • Property
                                                                                                                                            • -
                                                                                                                                          • Method
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Interface
                                                                                                                                            • -
                                                                                                                                          • Interface with type parameter
                                                                                                                                            • -
                                                                                                                                          • Constructor
                                                                                                                                            • -
                                                                                                                                          • Property
                                                                                                                                            • -
                                                                                                                                          • Method
                                                                                                                                            • -
                                                                                                                                          • Index signature
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Class
                                                                                                                                            • -
                                                                                                                                          • Class with type parameter
                                                                                                                                            • -
                                                                                                                                          • Constructor
                                                                                                                                            • -
                                                                                                                                          • Property
                                                                                                                                            • -
                                                                                                                                          • Method
                                                                                                                                            • -
                                                                                                                                          • Accessor
                                                                                                                                            • -
                                                                                                                                          • Index signature
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Inherited constructor
                                                                                                                                            • -
                                                                                                                                          • Inherited property
                                                                                                                                            • -
                                                                                                                                          • Inherited method
                                                                                                                                            • -
                                                                                                                                          • Inherited accessor
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Protected property
                                                                                                                                            • -
                                                                                                                                          • Protected method
                                                                                                                                            • -
                                                                                                                                          • Protected accessor
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Private property
                                                                                                                                            • -
                                                                                                                                          • Private method
                                                                                                                                            • -
                                                                                                                                          • Private accessor
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • Static property
                                                                                                                                            • -
                                                                                                                                          • Static method
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - - - - \ No newline at end of file +Field | Tableau Extensions API
                                                                                                                                          Tableau Extensions API
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface Field

                                                                                                                                            A field contains information about what data source it belongs to, +its role, and the ability to fetch the domain values.

                                                                                                                                            +
                                                                                                                                            interface Field {
                                                                                                                                                aggregation: FieldAggregationType;
                                                                                                                                                columnType: ColumnType;
                                                                                                                                                dataFormat?: DataFormat;
                                                                                                                                                dataSource: DataSource;
                                                                                                                                                dataType: undefined | DataType;
                                                                                                                                                description: undefined | string;
                                                                                                                                                id: string;
                                                                                                                                                isCalculatedField: boolean;
                                                                                                                                                isCombinedField: boolean;
                                                                                                                                                isGenerated: boolean;
                                                                                                                                                isGeospatial: boolean;
                                                                                                                                                isHidden: boolean;
                                                                                                                                                isPresentOnPublishedDatasource: boolean;
                                                                                                                                                name: string;
                                                                                                                                                role: FieldRoleType;
                                                                                                                                                semanticRole?: string;
                                                                                                                                            }
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            aggregation +columnType +dataFormat? +dataSource +dataType +description +id +isCalculatedField +isCombinedField +isGenerated +isGeospatial +isHidden +isPresentOnPublishedDatasource +name +role +semanticRole? +

                                                                                                                                            Properties

                                                                                                                                            aggregation: FieldAggregationType

                                                                                                                                            The type of aggregation for this field.

                                                                                                                                            +
                                                                                                                                            columnType: ColumnType

                                                                                                                                            The type of the column, either discrete or continuous. Could hold value 'Unknown'.

                                                                                                                                            +
                                                                                                                                            dataFormat?: DataFormat

                                                                                                                                            Data formatting options for the field.

                                                                                                                                            +

                                                                                                                                            1.16.0

                                                                                                                                            +
                                                                                                                                            dataSource: DataSource

                                                                                                                                            The data source to which this field belongs.

                                                                                                                                            +
                                                                                                                                            dataType: undefined | DataType

                                                                                                                                            The data type of the field

                                                                                                                                            +
                                                                                                                                            description: undefined | string

                                                                                                                                            User description of field, undefined if there is none.

                                                                                                                                            +
                                                                                                                                            id: string

                                                                                                                                            Unique string representing this field in this datasource.

                                                                                                                                            +
                                                                                                                                            isCalculatedField: boolean

                                                                                                                                            True if this field is a table calculation.

                                                                                                                                            +
                                                                                                                                            isCombinedField: boolean

                                                                                                                                            True if this field is a combination of multiple fields, false otherwise.

                                                                                                                                            +
                                                                                                                                            isGenerated: boolean

                                                                                                                                            True if this field is generated by Tableau, false otherwise. +Tableau generates a number of fields for a data source, such as Number +of Records, or Measure Values. This property can be used to +distinguish between those fields and fields that come from the underlying +data connection, or were created by a user.

                                                                                                                                            +
                                                                                                                                            isGeospatial: boolean

                                                                                                                                            True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name...

                                                                                                                                            +
                                                                                                                                            isHidden: boolean

                                                                                                                                            True if this field is hidden, false otherwise.

                                                                                                                                            +
                                                                                                                                            isPresentOnPublishedDatasource: boolean

                                                                                                                                            True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example).

                                                                                                                                            +
                                                                                                                                            name: string

                                                                                                                                            The name of the field (i.e. the caption).

                                                                                                                                            +
                                                                                                                                            role: FieldRoleType

                                                                                                                                            The role of this field.

                                                                                                                                            +
                                                                                                                                            semanticRole?: string

                                                                                                                                            The semantic role of the field. +Can be either a geographic role (e.g. latitude, longitude, city, country, etc...) or an image role

                                                                                                                                            +

                                                                                                                                            1.16.0

                                                                                                                                            +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/website/static/api/interfaces/fieldinstance.html b/website/static/api/interfaces/fieldinstance.html index 27495a3d..9ab5d58f 100644 --- a/website/static/api/interfaces/fieldinstance.html +++ b/website/static/api/interfaces/fieldinstance.html @@ -1,495 +1,67 @@ - - - - - - FieldInstance | Tableau Extensions - - - - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - Options -
                                                                                                                                            -
                                                                                                                                            - All -
                                                                                                                                              -
                                                                                                                                            • Public
                                                                                                                                              • -
                                                                                                                                            • Public/Protected
                                                                                                                                              • -
                                                                                                                                            • All
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            - - - - -
                                                                                                                                            -
                                                                                                                                            - Menu -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Interface FieldInstance

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            since
                                                                                                                                            -

                                                                                                                                            1.11.0 - Represents a field and its properties

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Hierarchy

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • - FieldBase -
                                                                                                                                                -
                                                                                                                                              • - FieldInstance -
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Index

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Properties

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Properties

                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            aggregation

                                                                                                                                            -
                                                                                                                                            aggregation: FieldAggregationType
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The type of aggregation for this field.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            columnType

                                                                                                                                            -
                                                                                                                                            columnType: ColumnType
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The type of the column, either discrete or continuous. Could hold value 'Unknown'.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            dataType

                                                                                                                                            -
                                                                                                                                            dataType: DataType | undefined
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The data type of the field

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            description

                                                                                                                                            -
                                                                                                                                            description: string | undefined
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            User description of field, undefined if there is none.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            fieldId

                                                                                                                                            -
                                                                                                                                            fieldId: string
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The unique representation of the field across all data sources in the workbook. In summary data, this includes aggregation. - Note that the fieldId could change if you change the data source. - For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become - [federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isCalculatedField

                                                                                                                                            -
                                                                                                                                            isCalculatedField: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this field is a table calculation.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isCombinedField

                                                                                                                                            -
                                                                                                                                            isCombinedField: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this field is a combination of multiple fields, false otherwise.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isGenerated

                                                                                                                                            -
                                                                                                                                            isGenerated: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this field is generated by Tableau, false otherwise. - Tableau generates a number of fields for a data source, such as Number - of Records, or Measure Values. This property can be used to - distinguish between those fields and fields that come from the underlying - data connection, or were created by a user.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isGeospatial

                                                                                                                                            -
                                                                                                                                            isGeospatial: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name...

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isHidden

                                                                                                                                            -
                                                                                                                                            isHidden: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this field is hidden, false otherwise.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            isPresentOnPublishedDatasource

                                                                                                                                            -
                                                                                                                                            isPresentOnPublishedDatasource: boolean
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example).

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            name

                                                                                                                                            -
                                                                                                                                            name: string
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The name of the field (i.e. the caption).

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            role

                                                                                                                                            -
                                                                                                                                            role: FieldRoleType
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            returns
                                                                                                                                            -

                                                                                                                                            The role of this field.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Legend

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Module
                                                                                                                                              • -
                                                                                                                                            • Object literal
                                                                                                                                              • -
                                                                                                                                            • Variable
                                                                                                                                              • -
                                                                                                                                            • Function
                                                                                                                                              • -
                                                                                                                                            • Function with type parameter
                                                                                                                                              • -
                                                                                                                                            • Index signature
                                                                                                                                              • -
                                                                                                                                            • Type alias
                                                                                                                                              • -
                                                                                                                                            • Type alias with type parameter
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Enumeration
                                                                                                                                              • -
                                                                                                                                            • Enumeration member
                                                                                                                                              • -
                                                                                                                                            • Property
                                                                                                                                              • -
                                                                                                                                            • Method
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Interface
                                                                                                                                              • -
                                                                                                                                            • Interface with type parameter
                                                                                                                                              • -
                                                                                                                                            • Constructor
                                                                                                                                              • -
                                                                                                                                            • Property
                                                                                                                                              • -
                                                                                                                                            • Method
                                                                                                                                              • -
                                                                                                                                            • Index signature
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Class
                                                                                                                                              • -
                                                                                                                                            • Class with type parameter
                                                                                                                                              • -
                                                                                                                                            • Constructor
                                                                                                                                              • -
                                                                                                                                            • Property
                                                                                                                                              • -
                                                                                                                                            • Method
                                                                                                                                              • -
                                                                                                                                            • Accessor
                                                                                                                                              • -
                                                                                                                                            • Index signature
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Inherited constructor
                                                                                                                                              • -
                                                                                                                                            • Inherited property
                                                                                                                                              • -
                                                                                                                                            • Inherited method
                                                                                                                                              • -
                                                                                                                                            • Inherited accessor
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Protected property
                                                                                                                                              • -
                                                                                                                                            • Protected method
                                                                                                                                              • -
                                                                                                                                            • Protected accessor
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Private property
                                                                                                                                              • -
                                                                                                                                            • Private method
                                                                                                                                              • -
                                                                                                                                            • Private accessor
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • Static property
                                                                                                                                              • -
                                                                                                                                            • Static method
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - - - - \ No newline at end of file +FieldInstance | Tableau Extensions API
                                                                                                                                            Tableau Extensions API
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface FieldInstance

                                                                                                                                              1.11.0 +Represents a field and its properties

                                                                                                                                              +
                                                                                                                                              interface FieldInstance {
                                                                                                                                                  aggregation: FieldAggregationType;
                                                                                                                                                  columnType: ColumnType;
                                                                                                                                                  dataFormat?: DataFormat;
                                                                                                                                                  dataType: undefined | DataType;
                                                                                                                                                  description: undefined | string;
                                                                                                                                                  fieldId: string;
                                                                                                                                                  isCalculatedField: boolean;
                                                                                                                                                  isCombinedField: boolean;
                                                                                                                                                  isGenerated: boolean;
                                                                                                                                                  isGeospatial: boolean;
                                                                                                                                                  isHidden: boolean;
                                                                                                                                                  isPresentOnPublishedDatasource: boolean;
                                                                                                                                                  name: string;
                                                                                                                                                  role: FieldRoleType;
                                                                                                                                                  semanticRole?: string;
                                                                                                                                              }
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              aggregation +columnType +dataFormat? +dataType +description +fieldId +isCalculatedField +isCombinedField +isGenerated +isGeospatial +isHidden +isPresentOnPublishedDatasource +name +role +semanticRole? +

                                                                                                                                              Properties

                                                                                                                                              aggregation: FieldAggregationType

                                                                                                                                              The type of aggregation for this field.

                                                                                                                                              +
                                                                                                                                              columnType: ColumnType

                                                                                                                                              The type of the column, either discrete or continuous. Could hold value 'Unknown'.

                                                                                                                                              +
                                                                                                                                              dataFormat?: DataFormat

                                                                                                                                              Data formatting options for the field.

                                                                                                                                              +

                                                                                                                                              1.16.0

                                                                                                                                              +
                                                                                                                                              dataType: undefined | DataType

                                                                                                                                              The data type of the field

                                                                                                                                              +
                                                                                                                                              description: undefined | string

                                                                                                                                              User description of field, undefined if there is none.

                                                                                                                                              +
                                                                                                                                              fieldId: string

                                                                                                                                              The unique representation of the field across all data sources in the workbook. In summary data, this includes aggregation. +Note that the fieldId could change if you change the data source. +For example after replacing the data source [Clipboard_20210305T164000].[sum:Sales:qk] could become +[federated.12usuoq1171o1b1ebdyh60fjnev1].[sum:Sales:qk].

                                                                                                                                              +
                                                                                                                                              isCalculatedField: boolean

                                                                                                                                              True if this field is a table calculation.

                                                                                                                                              +
                                                                                                                                              isCombinedField: boolean

                                                                                                                                              True if this field is a combination of multiple fields, false otherwise.

                                                                                                                                              +
                                                                                                                                              isGenerated: boolean

                                                                                                                                              True if this field is generated by Tableau, false otherwise. +Tableau generates a number of fields for a data source, such as Number +of Records, or Measure Values. This property can be used to +distinguish between those fields and fields that come from the underlying +data connection, or were created by a user.

                                                                                                                                              +
                                                                                                                                              isGeospatial: boolean

                                                                                                                                              True if this role has a semantic type of geospatial: e.g latitude, longitude, zipcode, City name...

                                                                                                                                              +
                                                                                                                                              isHidden: boolean

                                                                                                                                              True if this field is hidden, false otherwise.

                                                                                                                                              +
                                                                                                                                              isPresentOnPublishedDatasource: boolean

                                                                                                                                              True if this field comes from the published datasource. False if it was created in Tableau (as a calculated field, for example).

                                                                                                                                              +
                                                                                                                                              name: string

                                                                                                                                              The name of the field (i.e. the caption).

                                                                                                                                              +
                                                                                                                                              role: FieldRoleType

                                                                                                                                              The role of this field.

                                                                                                                                              +
                                                                                                                                              semanticRole?: string

                                                                                                                                              The semantic role of the field. +Can be either a geographic role (e.g. latitude, longitude, city, country, etc...) or an image role

                                                                                                                                              +

                                                                                                                                              1.16.0

                                                                                                                                              +

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Properties
                                                                                                                                              diff --git a/website/static/api/interfaces/filter.html b/website/static/api/interfaces/filter.html index e2171926..88486403 100644 --- a/website/static/api/interfaces/filter.html +++ b/website/static/api/interfaces/filter.html @@ -1,402 +1,47 @@ - - - - - - Filter | Tableau Extensions - - - - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - Options -
                                                                                                                                              -
                                                                                                                                              - All -
                                                                                                                                                -
                                                                                                                                              • Public
                                                                                                                                                • -
                                                                                                                                              • Public/Protected
                                                                                                                                                • -
                                                                                                                                              • All
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              - - - - -
                                                                                                                                              -
                                                                                                                                              - Menu -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              Interface Filter

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              An abstract base class for all of the filter types.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Hierarchy

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Index

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Properties

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Methods

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Properties

                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              fieldId

                                                                                                                                              -
                                                                                                                                              fieldId: string
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              returns
                                                                                                                                              -

                                                                                                                                              The id of the field being filtered.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              fieldName

                                                                                                                                              -
                                                                                                                                              fieldName: string
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              returns
                                                                                                                                              -

                                                                                                                                              The name of the field being filtered. Note that this is the caption - as shown in the UI, and not the actual database field name.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              filterType

                                                                                                                                              -
                                                                                                                                              filterType: FilterType
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              returns
                                                                                                                                              -

                                                                                                                                              The type of the filter.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              worksheetName

                                                                                                                                              -
                                                                                                                                              worksheetName: string
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              returns
                                                                                                                                              -

                                                                                                                                              The parent worksheet.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Methods

                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              getAppliedWorksheetsAsync

                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • getAppliedWorksheetsAsync(): Promise<Array<string>>
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                since
                                                                                                                                                -

                                                                                                                                                1.9.0 and Tableau 2022.2

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Returns Promise<Array<string>>

                                                                                                                                                -

                                                                                                                                                the list of worksheet names that have the filter applied.

                                                                                                                                                -
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              getFieldAsync

                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • getFieldAsync(): Promise<Field>
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                since
                                                                                                                                                -

                                                                                                                                                1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Returns Promise<Field>

                                                                                                                                                -

                                                                                                                                                a promise containing the field for the filter.

                                                                                                                                                -
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              setAppliedWorksheetsAsync

                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • - -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                since
                                                                                                                                                -

                                                                                                                                                1.9.0 and Tableau 2022.2

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • -
                                                                                                                                                  applyToWorksheets: Array<string>
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  list of worksheets to apply the filter on

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  • -
                                                                                                                                                -

                                                                                                                                                Returns Promise<Array<string>>

                                                                                                                                                -

                                                                                                                                                the list of worksheet names that have the filter applied

                                                                                                                                                -
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Legend

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Module
                                                                                                                                                • -
                                                                                                                                              • Object literal
                                                                                                                                                • -
                                                                                                                                              • Variable
                                                                                                                                                • -
                                                                                                                                              • Function
                                                                                                                                                • -
                                                                                                                                              • Function with type parameter
                                                                                                                                                • -
                                                                                                                                              • Index signature
                                                                                                                                                • -
                                                                                                                                              • Type alias
                                                                                                                                                • -
                                                                                                                                              • Type alias with type parameter
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Enumeration
                                                                                                                                                • -
                                                                                                                                              • Enumeration member
                                                                                                                                                • -
                                                                                                                                              • Property
                                                                                                                                                • -
                                                                                                                                              • Method
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Interface
                                                                                                                                                • -
                                                                                                                                              • Interface with type parameter
                                                                                                                                                • -
                                                                                                                                              • Constructor
                                                                                                                                                • -
                                                                                                                                              • Property
                                                                                                                                                • -
                                                                                                                                              • Method
                                                                                                                                                • -
                                                                                                                                              • Index signature
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Class
                                                                                                                                                • -
                                                                                                                                              • Class with type parameter
                                                                                                                                                • -
                                                                                                                                              • Constructor
                                                                                                                                                • -
                                                                                                                                              • Property
                                                                                                                                                • -
                                                                                                                                              • Method
                                                                                                                                                • -
                                                                                                                                              • Accessor
                                                                                                                                                • -
                                                                                                                                              • Index signature
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Inherited constructor
                                                                                                                                                • -
                                                                                                                                              • Inherited property
                                                                                                                                                • -
                                                                                                                                              • Inherited method
                                                                                                                                                • -
                                                                                                                                              • Inherited accessor
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Protected property
                                                                                                                                                • -
                                                                                                                                              • Protected method
                                                                                                                                                • -
                                                                                                                                              • Protected accessor
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Private property
                                                                                                                                                • -
                                                                                                                                              • Private method
                                                                                                                                                • -
                                                                                                                                              • Private accessor
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                              • Static property
                                                                                                                                                • -
                                                                                                                                              • Static method
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - - - - \ No newline at end of file +Filter | Tableau Extensions API
                                                                                                                                              Tableau Extensions API
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface Filter

                                                                                                                                                An abstract base class for all of the filter types.

                                                                                                                                                +
                                                                                                                                                interface Filter {
                                                                                                                                                    fieldId: string;
                                                                                                                                                    fieldName: string;
                                                                                                                                                    filterType: FilterType;
                                                                                                                                                    worksheetName: string;
                                                                                                                                                    getAppliedWorksheetsAsync(): Promise<string[]>;
                                                                                                                                                    getFieldAsync(): Promise<Field>;
                                                                                                                                                    setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
                                                                                                                                                }

                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                fieldId +fieldName +filterType +worksheetName +

                                                                                                                                                Methods

                                                                                                                                                getAppliedWorksheetsAsync +getFieldAsync +setAppliedWorksheetsAsync +

                                                                                                                                                Properties

                                                                                                                                                fieldId: string

                                                                                                                                                The id of the field being filtered.

                                                                                                                                                +
                                                                                                                                                fieldName: string

                                                                                                                                                The name of the field being filtered. Note that this is the caption +as shown in the UI, and not the actual database field name.

                                                                                                                                                +
                                                                                                                                                filterType: FilterType

                                                                                                                                                The type of the filter.

                                                                                                                                                +
                                                                                                                                                worksheetName: string

                                                                                                                                                The parent worksheet.

                                                                                                                                                +

                                                                                                                                                Methods

                                                                                                                                                • Returns Promise<string[]>

                                                                                                                                                  the list of worksheet names that have the filter applied.

                                                                                                                                                  +

                                                                                                                                                  1.9.0 and Tableau 2022.2

                                                                                                                                                  +

                                                                                                                                                • Returns Promise<Field>

                                                                                                                                                  a promise containing the field for the filter.

                                                                                                                                                  +

                                                                                                                                                  1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                  +

                                                                                                                                                • Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                  +

                                                                                                                                                  Parameters

                                                                                                                                                  • applyToWorksheets: string[]

                                                                                                                                                    list of worksheets to apply the filter on

                                                                                                                                                    +

                                                                                                                                                  Returns Promise<string[]>

                                                                                                                                                  the list of worksheet names that have the filter applied

                                                                                                                                                  +

                                                                                                                                                  1.9.0 and Tableau 2022.2

                                                                                                                                                  +

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                On This Page

                                                                                                                                                Properties
                                                                                                                                                Methods
                                                                                                                                                diff --git a/website/static/api/interfaces/filterchangedevent.html b/website/static/api/interfaces/filterchangedevent.html index d067cce1..222a21cd 100644 --- a/website/static/api/interfaces/filterchangedevent.html +++ b/website/static/api/interfaces/filterchangedevent.html @@ -1,312 +1,36 @@ - - - - - - FilterChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - Options -
                                                                                                                                                -
                                                                                                                                                - All -
                                                                                                                                                  -
                                                                                                                                                • Public
                                                                                                                                                  • -
                                                                                                                                                • Public/Protected
                                                                                                                                                  • -
                                                                                                                                                • All
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                - - - - -
                                                                                                                                                -
                                                                                                                                                - Menu -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                Interface FilterChangedEvent

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Hierarchy

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Index

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Properties

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Methods

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Properties

                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                fieldName

                                                                                                                                                -
                                                                                                                                                fieldName: string
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                returns
                                                                                                                                                -

                                                                                                                                                The name of the field being filtered.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                sheet

                                                                                                                                                -
                                                                                                                                                sheet: Sheet
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                returns
                                                                                                                                                -

                                                                                                                                                The sheet which was the source of this event.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                type

                                                                                                                                                -
                                                                                                                                                type: TableauEventType
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                returns
                                                                                                                                                -

                                                                                                                                                The type of event which this class is representing.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                worksheet

                                                                                                                                                -
                                                                                                                                                worksheet: Worksheet
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                returns
                                                                                                                                                -

                                                                                                                                                The worksheet which was the source of this event.

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Methods

                                                                                                                                                -
                                                                                                                                                - -

                                                                                                                                                getFilterAsync

                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • getFilterAsync(): Promise<Filter>
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • - -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Returns Promise<Filter>

                                                                                                                                                  -

                                                                                                                                                  The Filter object associated with the event.

                                                                                                                                                  -
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Legend

                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Module
                                                                                                                                                  • -
                                                                                                                                                • Object literal
                                                                                                                                                  • -
                                                                                                                                                • Variable
                                                                                                                                                  • -
                                                                                                                                                • Function
                                                                                                                                                  • -
                                                                                                                                                • Function with type parameter
                                                                                                                                                  • -
                                                                                                                                                • Index signature
                                                                                                                                                  • -
                                                                                                                                                • Type alias
                                                                                                                                                  • -
                                                                                                                                                • Type alias with type parameter
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Enumeration
                                                                                                                                                  • -
                                                                                                                                                • Enumeration member
                                                                                                                                                  • -
                                                                                                                                                • Property
                                                                                                                                                  • -
                                                                                                                                                • Method
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Interface
                                                                                                                                                  • -
                                                                                                                                                • Interface with type parameter
                                                                                                                                                  • -
                                                                                                                                                • Constructor
                                                                                                                                                  • -
                                                                                                                                                • Property
                                                                                                                                                  • -
                                                                                                                                                • Method
                                                                                                                                                  • -
                                                                                                                                                • Index signature
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Class
                                                                                                                                                  • -
                                                                                                                                                • Class with type parameter
                                                                                                                                                  • -
                                                                                                                                                • Constructor
                                                                                                                                                  • -
                                                                                                                                                • Property
                                                                                                                                                  • -
                                                                                                                                                • Method
                                                                                                                                                  • -
                                                                                                                                                • Accessor
                                                                                                                                                  • -
                                                                                                                                                • Index signature
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Inherited constructor
                                                                                                                                                  • -
                                                                                                                                                • Inherited property
                                                                                                                                                  • -
                                                                                                                                                • Inherited method
                                                                                                                                                  • -
                                                                                                                                                • Inherited accessor
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Protected property
                                                                                                                                                  • -
                                                                                                                                                • Protected method
                                                                                                                                                  • -
                                                                                                                                                • Protected accessor
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Private property
                                                                                                                                                  • -
                                                                                                                                                • Private method
                                                                                                                                                  • -
                                                                                                                                                • Private accessor
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                • Static property
                                                                                                                                                  • -
                                                                                                                                                • Static method
                                                                                                                                                  • -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - - - - \ No newline at end of file +FilterChangedEvent | Tableau Extensions API
                                                                                                                                                Tableau Extensions API
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface FilterChangedEvent

                                                                                                                                                  An event which is related to a particular Worksheet in the workbook.

                                                                                                                                                  +
                                                                                                                                                  interface FilterChangedEvent {
                                                                                                                                                      fieldName: string;
                                                                                                                                                      sheet: Sheet;
                                                                                                                                                      type: TableauEventType;
                                                                                                                                                      worksheet: Worksheet;
                                                                                                                                                      getFilterAsync(): Promise<Filter>;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  fieldName +sheet +type +worksheet +

                                                                                                                                                  Methods

                                                                                                                                                  getFilterAsync +

                                                                                                                                                  Properties

                                                                                                                                                  fieldName: string

                                                                                                                                                  The name of the field being filtered.

                                                                                                                                                  +
                                                                                                                                                  sheet: Sheet

                                                                                                                                                  The sheet which was the source of this event.

                                                                                                                                                  +
                                                                                                                                                  type: TableauEventType

                                                                                                                                                  The type of event which this class is representing.

                                                                                                                                                  +
                                                                                                                                                  worksheet: Worksheet

                                                                                                                                                  The worksheet which was the source of this event.

                                                                                                                                                  +

                                                                                                                                                  Methods

                                                                                                                                                  • Returns Promise<Filter>

                                                                                                                                                    The Filter object associated with the event.

                                                                                                                                                    +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  Methods
                                                                                                                                                  diff --git a/website/static/api/interfaces/filteroptions.html b/website/static/api/interfaces/filteroptions.html index c7bda01f..80559bf7 100644 --- a/website/static/api/interfaces/filteroptions.html +++ b/website/static/api/interfaces/filteroptions.html @@ -1,216 +1,30 @@ - - - - - - FilterOptions | Tableau Extensions - - - - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  - Options -
                                                                                                                                                  -
                                                                                                                                                  - All -
                                                                                                                                                    -
                                                                                                                                                  • Public
                                                                                                                                                    • -
                                                                                                                                                  • Public/Protected
                                                                                                                                                    • -
                                                                                                                                                  • All
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  - - - - -
                                                                                                                                                  -
                                                                                                                                                  - Menu -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  Interface FilterOptions

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Passed into the applyFilter methods to control advanced filtering options.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Hierarchy

                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • - FilterOptions -
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Index

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Properties

                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Properties

                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  isExcludeMode

                                                                                                                                                  -
                                                                                                                                                  isExcludeMode: boolean
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Determines whether the filter will apply in exclude mode or include mode. - The default is include, which means that you use the fields as part of a filter. - Exclude mode means that you include everything else except the specified fields.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Legend

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Module
                                                                                                                                                    • -
                                                                                                                                                  • Object literal
                                                                                                                                                    • -
                                                                                                                                                  • Variable
                                                                                                                                                    • -
                                                                                                                                                  • Function
                                                                                                                                                    • -
                                                                                                                                                  • Function with type parameter
                                                                                                                                                    • -
                                                                                                                                                  • Index signature
                                                                                                                                                    • -
                                                                                                                                                  • Type alias
                                                                                                                                                    • -
                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Enumeration
                                                                                                                                                    • -
                                                                                                                                                  • Enumeration member
                                                                                                                                                    • -
                                                                                                                                                  • Property
                                                                                                                                                    • -
                                                                                                                                                  • Method
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Interface
                                                                                                                                                    • -
                                                                                                                                                  • Interface with type parameter
                                                                                                                                                    • -
                                                                                                                                                  • Constructor
                                                                                                                                                    • -
                                                                                                                                                  • Property
                                                                                                                                                    • -
                                                                                                                                                  • Method
                                                                                                                                                    • -
                                                                                                                                                  • Index signature
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Class
                                                                                                                                                    • -
                                                                                                                                                  • Class with type parameter
                                                                                                                                                    • -
                                                                                                                                                  • Constructor
                                                                                                                                                    • -
                                                                                                                                                  • Property
                                                                                                                                                    • -
                                                                                                                                                  • Method
                                                                                                                                                    • -
                                                                                                                                                  • Accessor
                                                                                                                                                    • -
                                                                                                                                                  • Index signature
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Inherited constructor
                                                                                                                                                    • -
                                                                                                                                                  • Inherited property
                                                                                                                                                    • -
                                                                                                                                                  • Inherited method
                                                                                                                                                    • -
                                                                                                                                                  • Inherited accessor
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Protected property
                                                                                                                                                    • -
                                                                                                                                                  • Protected method
                                                                                                                                                    • -
                                                                                                                                                  • Protected accessor
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Private property
                                                                                                                                                    • -
                                                                                                                                                  • Private method
                                                                                                                                                    • -
                                                                                                                                                  • Private accessor
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • Static property
                                                                                                                                                    • -
                                                                                                                                                  • Static method
                                                                                                                                                    • -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - - - - \ No newline at end of file +FilterOptions | Tableau Extensions API
                                                                                                                                                  Tableau Extensions API
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface FilterOptions

                                                                                                                                                    Passed into the applyFilter methods to control advanced filtering options.

                                                                                                                                                    +
                                                                                                                                                    interface FilterOptions {
                                                                                                                                                        isExcludeMode: boolean;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    isExcludeMode +

                                                                                                                                                    Properties

                                                                                                                                                    isExcludeMode: boolean

                                                                                                                                                    Determines whether the filter will apply in exclude mode or include mode. +The default is include, which means that you use the fields as part of a filter. +Exclude mode means that you include everything else except the specified fields.

                                                                                                                                                    +

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    diff --git a/website/static/api/interfaces/formattingsheet.html b/website/static/api/interfaces/formattingsheet.html index b43b3776..9d404297 100644 --- a/website/static/api/interfaces/formattingsheet.html +++ b/website/static/api/interfaces/formattingsheet.html @@ -1,227 +1,30 @@ - - - - - - FormattingSheet | Tableau Extensions - - - - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    - Options -
                                                                                                                                                    -
                                                                                                                                                    - All -
                                                                                                                                                      -
                                                                                                                                                    • Public
                                                                                                                                                      • -
                                                                                                                                                    • Public/Protected
                                                                                                                                                      • -
                                                                                                                                                    • All
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    - - - - -
                                                                                                                                                    -
                                                                                                                                                    - Menu -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -

                                                                                                                                                    Interface FormattingSheet

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Hierarchy

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • - FormattingSheet -
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Index

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Properties

                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Properties

                                                                                                                                                    -
                                                                                                                                                    - -

                                                                                                                                                    classNameKey

                                                                                                                                                    -
                                                                                                                                                    classNameKey: ClassNameKey
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    returns
                                                                                                                                                    -

                                                                                                                                                    Is an object that contains a ClassNameKey which represents a type of - formatting in a workbook: WorksheetTitle, Worksheet, Tooltip, StoryTitle, and DashboardTitle.

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    since
                                                                                                                                                    -

                                                                                                                                                    1.7.0 and Tableau 2021.4

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -

                                                                                                                                                    cssProperties

                                                                                                                                                    -
                                                                                                                                                    cssProperties: CSSProperties
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Legend

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Module
                                                                                                                                                      • -
                                                                                                                                                    • Object literal
                                                                                                                                                      • -
                                                                                                                                                    • Variable
                                                                                                                                                      • -
                                                                                                                                                    • Function
                                                                                                                                                      • -
                                                                                                                                                    • Function with type parameter
                                                                                                                                                      • -
                                                                                                                                                    • Index signature
                                                                                                                                                      • -
                                                                                                                                                    • Type alias
                                                                                                                                                      • -
                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Enumeration
                                                                                                                                                      • -
                                                                                                                                                    • Enumeration member
                                                                                                                                                      • -
                                                                                                                                                    • Property
                                                                                                                                                      • -
                                                                                                                                                    • Method
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Interface
                                                                                                                                                      • -
                                                                                                                                                    • Interface with type parameter
                                                                                                                                                      • -
                                                                                                                                                    • Constructor
                                                                                                                                                      • -
                                                                                                                                                    • Property
                                                                                                                                                      • -
                                                                                                                                                    • Method
                                                                                                                                                      • -
                                                                                                                                                    • Index signature
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Class
                                                                                                                                                      • -
                                                                                                                                                    • Class with type parameter
                                                                                                                                                      • -
                                                                                                                                                    • Constructor
                                                                                                                                                      • -
                                                                                                                                                    • Property
                                                                                                                                                      • -
                                                                                                                                                    • Method
                                                                                                                                                      • -
                                                                                                                                                    • Accessor
                                                                                                                                                      • -
                                                                                                                                                    • Index signature
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Inherited constructor
                                                                                                                                                      • -
                                                                                                                                                    • Inherited property
                                                                                                                                                      • -
                                                                                                                                                    • Inherited method
                                                                                                                                                      • -
                                                                                                                                                    • Inherited accessor
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Protected property
                                                                                                                                                      • -
                                                                                                                                                    • Protected method
                                                                                                                                                      • -
                                                                                                                                                    • Protected accessor
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Private property
                                                                                                                                                      • -
                                                                                                                                                    • Private method
                                                                                                                                                      • -
                                                                                                                                                    • Private accessor
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • Static property
                                                                                                                                                      • -
                                                                                                                                                    • Static method
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - - - - \ No newline at end of file +FormattingSheet | Tableau Extensions API
                                                                                                                                                    Tableau Extensions API
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface FormattingSheet

                                                                                                                                                      interface FormattingSheet {
                                                                                                                                                          classNameKey: ClassNameKey;
                                                                                                                                                          cssProperties: CSSProperties;
                                                                                                                                                      }
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      classNameKey +cssProperties +

                                                                                                                                                      Properties

                                                                                                                                                      classNameKey: ClassNameKey

                                                                                                                                                      Is an object that contains a ClassNameKey which represents a type of +formatting in a workbook: WorksheetTitle, Worksheet, Tooltip, StoryTitle, and DashboardTitle.

                                                                                                                                                      +

                                                                                                                                                      1.7.0 and Tableau 2021.4

                                                                                                                                                      +
                                                                                                                                                      cssProperties: CSSProperties

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      diff --git a/website/static/api/interfaces/getsummarydataoptions.html b/website/static/api/interfaces/getsummarydataoptions.html index 83a79467..76cb4338 100644 --- a/website/static/api/interfaces/getsummarydataoptions.html +++ b/website/static/api/interfaces/getsummarydataoptions.html @@ -1,344 +1,50 @@ - - - - - - GetSummaryDataOptions | Tableau Extensions - - - - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - Options -
                                                                                                                                                      -
                                                                                                                                                      - All -
                                                                                                                                                        -
                                                                                                                                                      • Public
                                                                                                                                                        • -
                                                                                                                                                      • Public/Protected
                                                                                                                                                        • -
                                                                                                                                                      • All
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      - - - - -
                                                                                                                                                      -
                                                                                                                                                      - Menu -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Interface GetSummaryDataOptions

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Options argument for the Worksheet.GetSummaryDataAsync API

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Hierarchy

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Index

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Properties

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Properties

                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional applyWorksheetFormatting

                                                                                                                                                      -
                                                                                                                                                      applyWorksheetFormatting: undefined | false | true
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Specifies whether to apply worksheet level formatting to numbers and dates - Note that this is different from the global field formatting degined in the Schema Viewer

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      since
                                                                                                                                                      -

                                                                                                                                                      1.13.0 and Tableau 2025.1

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional columnsToIncludeById

                                                                                                                                                      -
                                                                                                                                                      columnsToIncludeById: Array<string>
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      The columns to return specified by field id, returns all by default. - Since 1.5.0, fieldId is a property of the Column object.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      since
                                                                                                                                                      -

                                                                                                                                                      1.5.0

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional ignoreAliases

                                                                                                                                                      -
                                                                                                                                                      ignoreAliases: undefined | false | true
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Do not use aliases specified in the data source in Tableau. Default is false.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional ignoreSelection

                                                                                                                                                      -
                                                                                                                                                      ignoreSelection: undefined | false | true
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Only return data for the currently selected marks. Default is false.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional includeDataValuesOption

                                                                                                                                                      -
                                                                                                                                                      includeDataValuesOption: IncludeDataValuesOption
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues. - All properties not requested will be undefined in the DataValue results. - This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      since
                                                                                                                                                      -

                                                                                                                                                      1.5.0

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Optional maxRows

                                                                                                                                                      -
                                                                                                                                                      maxRows: undefined | number
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      The number of rows of data that you want to return. A value of 0 will attempt to return all rows. - 0 is the default if maxRows is not specified. - getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows. - getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      since
                                                                                                                                                      -

                                                                                                                                                      1.5.0 maxRows is now supported in both GetSummaryDataOptions and GetUnderlyingDataOptions.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      since
                                                                                                                                                      -

                                                                                                                                                      1.10.0 maxRows is ignored when getting a DataTableReader

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Legend

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Module
                                                                                                                                                        • -
                                                                                                                                                      • Object literal
                                                                                                                                                        • -
                                                                                                                                                      • Variable
                                                                                                                                                        • -
                                                                                                                                                      • Function
                                                                                                                                                        • -
                                                                                                                                                      • Function with type parameter
                                                                                                                                                        • -
                                                                                                                                                      • Index signature
                                                                                                                                                        • -
                                                                                                                                                      • Type alias
                                                                                                                                                        • -
                                                                                                                                                      • Type alias with type parameter
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Enumeration
                                                                                                                                                        • -
                                                                                                                                                      • Enumeration member
                                                                                                                                                        • -
                                                                                                                                                      • Property
                                                                                                                                                        • -
                                                                                                                                                      • Method
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Interface
                                                                                                                                                        • -
                                                                                                                                                      • Interface with type parameter
                                                                                                                                                        • -
                                                                                                                                                      • Constructor
                                                                                                                                                        • -
                                                                                                                                                      • Property
                                                                                                                                                        • -
                                                                                                                                                      • Method
                                                                                                                                                        • -
                                                                                                                                                      • Index signature
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Class
                                                                                                                                                        • -
                                                                                                                                                      • Class with type parameter
                                                                                                                                                        • -
                                                                                                                                                      • Constructor
                                                                                                                                                        • -
                                                                                                                                                      • Property
                                                                                                                                                        • -
                                                                                                                                                      • Method
                                                                                                                                                        • -
                                                                                                                                                      • Accessor
                                                                                                                                                        • -
                                                                                                                                                      • Index signature
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Inherited constructor
                                                                                                                                                        • -
                                                                                                                                                      • Inherited property
                                                                                                                                                        • -
                                                                                                                                                      • Inherited method
                                                                                                                                                        • -
                                                                                                                                                      • Inherited accessor
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Protected property
                                                                                                                                                        • -
                                                                                                                                                      • Protected method
                                                                                                                                                        • -
                                                                                                                                                      • Protected accessor
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Private property
                                                                                                                                                        • -
                                                                                                                                                      • Private method
                                                                                                                                                        • -
                                                                                                                                                      • Private accessor
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • Static property
                                                                                                                                                        • -
                                                                                                                                                      • Static method
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - - - - \ No newline at end of file +GetSummaryDataOptions | Tableau Extensions API
                                                                                                                                                      Tableau Extensions API
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface GetSummaryDataOptions

                                                                                                                                                        Options argument for the Worksheet.GetSummaryDataAsync API

                                                                                                                                                        +
                                                                                                                                                        interface GetSummaryDataOptions {
                                                                                                                                                            applyWorksheetFormatting?: boolean;
                                                                                                                                                            columnsToIncludeById?: string[];
                                                                                                                                                            ignoreAliases?: boolean;
                                                                                                                                                            ignoreSelection?: boolean;
                                                                                                                                                            includeDataValuesOption?: IncludeDataValuesOption;
                                                                                                                                                            maxRows?: number;
                                                                                                                                                        }

                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        applyWorksheetFormatting? +columnsToIncludeById? +ignoreAliases? +ignoreSelection? +includeDataValuesOption? +maxRows? +

                                                                                                                                                        Properties

                                                                                                                                                        applyWorksheetFormatting?: boolean

                                                                                                                                                        Specifies whether to apply worksheet level formatting to numbers and dates +Note that this is different from the global field formatting degined in the Schema Viewer

                                                                                                                                                        +

                                                                                                                                                        1.13.0 and Tableau 2025.1

                                                                                                                                                        +
                                                                                                                                                        columnsToIncludeById?: string[]

                                                                                                                                                        The columns to return specified by field id, returns all by default. +Since 1.5.0, fieldId is a property of the Column object.

                                                                                                                                                        +

                                                                                                                                                        1.5.0

                                                                                                                                                        +
                                                                                                                                                        ignoreAliases?: boolean

                                                                                                                                                        Do not use aliases specified in the data source in Tableau. Default is false.

                                                                                                                                                        +
                                                                                                                                                        ignoreSelection?: boolean

                                                                                                                                                        Only return data for the currently selected marks. Default is false.

                                                                                                                                                        +
                                                                                                                                                        includeDataValuesOption?: IncludeDataValuesOption

                                                                                                                                                        Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues. +All properties not requested will be undefined in the DataValue results. +This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.

                                                                                                                                                        +

                                                                                                                                                        1.5.0

                                                                                                                                                        +
                                                                                                                                                        maxRows?: number

                                                                                                                                                        The number of rows of data that you want to return. A value of 0 will attempt to return all rows. +0 is the default if maxRows is not specified. +getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows. +getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.

                                                                                                                                                        +

                                                                                                                                                        1.5.0 maxRows is now supported in both GetSummaryDataOptions and GetUnderlyingDataOptions.

                                                                                                                                                        +

                                                                                                                                                        1.10.0 maxRows is ignored when getting a DataTableReader

                                                                                                                                                        +

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        On This Page

                                                                                                                                                        Properties
                                                                                                                                                        diff --git a/website/static/api/interfaces/getunderlyingdataoptions.html b/website/static/api/interfaces/getunderlyingdataoptions.html index db608c04..15e7eed0 100644 --- a/website/static/api/interfaces/getunderlyingdataoptions.html +++ b/website/static/api/interfaces/getunderlyingdataoptions.html @@ -1,369 +1,52 @@ - - - - - - GetUnderlyingDataOptions | Tableau Extensions - - - - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - Options -
                                                                                                                                                        -
                                                                                                                                                        - All -
                                                                                                                                                          -
                                                                                                                                                        • Public
                                                                                                                                                          • -
                                                                                                                                                        • Public/Protected
                                                                                                                                                          • -
                                                                                                                                                        • All
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        - - - - -
                                                                                                                                                        -
                                                                                                                                                        - Menu -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Interface GetUnderlyingDataOptions

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Options argument for the Worksheet.getUnderlyingTableDataAsync API.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Hierarchy

                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Index

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Properties

                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Properties

                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional applyWorksheetFormatting

                                                                                                                                                        -
                                                                                                                                                        applyWorksheetFormatting: undefined | false | true
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Specifies whether to apply worksheet level formatting to numbers and dates - Note that this is different from the global field formatting degined in the Schema Viewer

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        since
                                                                                                                                                        -

                                                                                                                                                        1.13.0 and Tableau 2025.1

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional columnsToIncludeById

                                                                                                                                                        -
                                                                                                                                                        columnsToIncludeById: Array<string>
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        The columns to return specified by field id, returns all by default. - Since 1.5.0, fieldId is a property of the Column object.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        since
                                                                                                                                                        -

                                                                                                                                                        1.5.0

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional ignoreAliases

                                                                                                                                                        -
                                                                                                                                                        ignoreAliases: undefined | false | true
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Do not use aliases specified in the data source in Tableau. Default is false.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional ignoreSelection

                                                                                                                                                        -
                                                                                                                                                        ignoreSelection: undefined | false | true
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Only return data for the currently selected marks. Default is false.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional includeAllColumns

                                                                                                                                                        -
                                                                                                                                                        includeAllColumns: undefined | false | true
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Return all the columns for the data source. Default is false.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional includeDataValuesOption

                                                                                                                                                        -
                                                                                                                                                        includeDataValuesOption: IncludeDataValuesOption
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues. - All properties not requested will be undefined in the DataValue results. - This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        since
                                                                                                                                                        -

                                                                                                                                                        1.5.0

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Optional maxRows

                                                                                                                                                        -
                                                                                                                                                        maxRows: undefined | number
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        The number of rows of data that you want to return. A value of 0 will attempt to return all rows. - 0 is the default if maxRows is not specified. - getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows. - getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        since
                                                                                                                                                        -

                                                                                                                                                        1.5.0 maxRows is now supported in both GetSummaryDataOptions and GetUnderlyingDataOptions.

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        since
                                                                                                                                                        -

                                                                                                                                                        1.10.0 maxRows is ignored when getting a DataTableReader

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Legend

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Module
                                                                                                                                                          • -
                                                                                                                                                        • Object literal
                                                                                                                                                          • -
                                                                                                                                                        • Variable
                                                                                                                                                          • -
                                                                                                                                                        • Function
                                                                                                                                                          • -
                                                                                                                                                        • Function with type parameter
                                                                                                                                                          • -
                                                                                                                                                        • Index signature
                                                                                                                                                          • -
                                                                                                                                                        • Type alias
                                                                                                                                                          • -
                                                                                                                                                        • Type alias with type parameter
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Enumeration
                                                                                                                                                          • -
                                                                                                                                                        • Enumeration member
                                                                                                                                                          • -
                                                                                                                                                        • Property
                                                                                                                                                          • -
                                                                                                                                                        • Method
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Interface
                                                                                                                                                          • -
                                                                                                                                                        • Interface with type parameter
                                                                                                                                                          • -
                                                                                                                                                        • Constructor
                                                                                                                                                          • -
                                                                                                                                                        • Property
                                                                                                                                                          • -
                                                                                                                                                        • Method
                                                                                                                                                          • -
                                                                                                                                                        • Index signature
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Class
                                                                                                                                                          • -
                                                                                                                                                        • Class with type parameter
                                                                                                                                                          • -
                                                                                                                                                        • Constructor
                                                                                                                                                          • -
                                                                                                                                                        • Property
                                                                                                                                                          • -
                                                                                                                                                        • Method
                                                                                                                                                          • -
                                                                                                                                                        • Accessor
                                                                                                                                                          • -
                                                                                                                                                        • Index signature
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Inherited constructor
                                                                                                                                                          • -
                                                                                                                                                        • Inherited property
                                                                                                                                                          • -
                                                                                                                                                        • Inherited method
                                                                                                                                                          • -
                                                                                                                                                        • Inherited accessor
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Protected property
                                                                                                                                                          • -
                                                                                                                                                        • Protected method
                                                                                                                                                          • -
                                                                                                                                                        • Protected accessor
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Private property
                                                                                                                                                          • -
                                                                                                                                                        • Private method
                                                                                                                                                          • -
                                                                                                                                                        • Private accessor
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • Static property
                                                                                                                                                          • -
                                                                                                                                                        • Static method
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - - - - \ No newline at end of file +GetUnderlyingDataOptions | Tableau Extensions API
                                                                                                                                                        Tableau Extensions API
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Interface GetUnderlyingDataOptions

                                                                                                                                                          Options argument for the Worksheet.getUnderlyingTableDataAsync API.

                                                                                                                                                          +
                                                                                                                                                          interface GetUnderlyingDataOptions {
                                                                                                                                                              applyWorksheetFormatting?: boolean;
                                                                                                                                                              columnsToIncludeById?: string[];
                                                                                                                                                              ignoreAliases?: boolean;
                                                                                                                                                              ignoreSelection?: boolean;
                                                                                                                                                              includeAllColumns?: boolean;
                                                                                                                                                              includeDataValuesOption?: IncludeDataValuesOption;
                                                                                                                                                              maxRows?: number;
                                                                                                                                                          }

                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                          Index

                                                                                                                                                          Properties

                                                                                                                                                          applyWorksheetFormatting? +columnsToIncludeById? +ignoreAliases? +ignoreSelection? +includeAllColumns? +includeDataValuesOption? +maxRows? +

                                                                                                                                                          Properties

                                                                                                                                                          applyWorksheetFormatting?: boolean

                                                                                                                                                          Specifies whether to apply worksheet level formatting to numbers and dates +Note that this is different from the global field formatting degined in the Schema Viewer

                                                                                                                                                          +

                                                                                                                                                          1.13.0 and Tableau 2025.1

                                                                                                                                                          +
                                                                                                                                                          columnsToIncludeById?: string[]

                                                                                                                                                          The columns to return specified by field id, returns all by default. +Since 1.5.0, fieldId is a property of the Column object.

                                                                                                                                                          +

                                                                                                                                                          1.5.0

                                                                                                                                                          +
                                                                                                                                                          ignoreAliases?: boolean

                                                                                                                                                          Do not use aliases specified in the data source in Tableau. Default is false.

                                                                                                                                                          +
                                                                                                                                                          ignoreSelection?: boolean

                                                                                                                                                          Only return data for the currently selected marks. Default is false.

                                                                                                                                                          +
                                                                                                                                                          includeAllColumns?: boolean

                                                                                                                                                          Return all the columns for the data source. Default is false.

                                                                                                                                                          +
                                                                                                                                                          includeDataValuesOption?: IncludeDataValuesOption

                                                                                                                                                          Specify which properties to return in DataValues. The default is IncludeDataValuesOption.AllValues. +All properties not requested will be undefined in the DataValue results. +This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.

                                                                                                                                                          +

                                                                                                                                                          1.5.0

                                                                                                                                                          +
                                                                                                                                                          maxRows?: number

                                                                                                                                                          The number of rows of data that you want to return. A value of 0 will attempt to return all rows. +0 is the default if maxRows is not specified. +getUnderlyingTableDataAsync - maximum number of rows returned is capped at 10,000 regardless of maxRows. +getSummaryDataAsync - maximum number of rows returned is not capped, but performance may suffer with large row counts.

                                                                                                                                                          +

                                                                                                                                                          1.5.0 maxRows is now supported in both GetSummaryDataOptions and GetUnderlyingDataOptions.

                                                                                                                                                          +

                                                                                                                                                          1.10.0 maxRows is ignored when getting a DataTableReader

                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          diff --git a/website/static/api/interfaces/hierarchicalfilter.html b/website/static/api/interfaces/hierarchicalfilter.html index b716b069..2bece8ef 100644 --- a/website/static/api/interfaces/hierarchicalfilter.html +++ b/website/static/api/interfaces/hierarchicalfilter.html @@ -1,535 +1,64 @@ - - - - - - HierarchicalFilter | Tableau Extensions - - - - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - Options -
                                                                                                                                                          -
                                                                                                                                                          - All -
                                                                                                                                                            -
                                                                                                                                                          • Public
                                                                                                                                                            • -
                                                                                                                                                          • Public/Protected
                                                                                                                                                            • -
                                                                                                                                                          • All
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          - - - - -
                                                                                                                                                          -
                                                                                                                                                          - Menu -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          Interface HierarchicalFilter

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          A Hierarchical Filter - Hierarchical Filters are used when a hierarchical field is used as a filter on a cube database. - As an example, assume a hierarchical field in Product, named ByCategory. - ByCategory has the following five levels: Family, Category, Subcategory, Brand, Sku.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          since
                                                                                                                                                          -

                                                                                                                                                          Extensions 1.10.0 and Tableau version 2022.3

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Hierarchy

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - Filter -
                                                                                                                                                              -
                                                                                                                                                            • - HierarchicalFilter -
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Index

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Properties

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Methods

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Properties

                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          appliedValues

                                                                                                                                                          -
                                                                                                                                                          appliedValues: Array<HierarchicalFilterDataValue>
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          A list of values applied to this hierarchical filter.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          dimensionName

                                                                                                                                                          -
                                                                                                                                                          dimensionName: string
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The dimension name associated with the filter. In the ByCategory filter example, this would be 'Product'

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          fieldId

                                                                                                                                                          -
                                                                                                                                                          fieldId: string
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The id of the field being filtered.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          fieldName

                                                                                                                                                          -
                                                                                                                                                          fieldName: string
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The name of the field being filtered. Note that this is the caption - as shown in the UI, and not the actual database field name.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          filterType

                                                                                                                                                          -
                                                                                                                                                          filterType: FilterType
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The type of the filter.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          hierarchyCaption

                                                                                                                                                          -
                                                                                                                                                          hierarchyCaption: string
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The hierarchy caption associated with the filter. In the ByCategory filter example, this would be '[Product].[ByCategory]'

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          isAllSelected

                                                                                                                                                          -
                                                                                                                                                          isAllSelected: boolean
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          True if all the values are selected for this filter. When 'All' is selected, - appliedValues returns an empty list.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          levelDetails

                                                                                                                                                          -
                                                                                                                                                          levelDetails: Array<HierarchicalLevelDetail>
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          Details about each level in the hierarchical filter.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          numberOfLevels

                                                                                                                                                          -
                                                                                                                                                          numberOfLevels: number
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The number of levels in the hierarchical filter. In the ByCategory filter example, this would be 5

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          worksheetName

                                                                                                                                                          -
                                                                                                                                                          worksheetName: string
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          returns
                                                                                                                                                          -

                                                                                                                                                          The parent worksheet.

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Methods

                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          getAppliedWorksheetsAsync

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • getAppliedWorksheetsAsync(): Promise<Array<string>>
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            since
                                                                                                                                                            -

                                                                                                                                                            1.9.0 and Tableau 2022.2

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Returns Promise<Array<string>>

                                                                                                                                                            -

                                                                                                                                                            the list of worksheet names that have the filter applied.

                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          getFieldAsync

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • getFieldAsync(): Promise<Field>
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            since
                                                                                                                                                            -

                                                                                                                                                            1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Returns Promise<Field>

                                                                                                                                                            -

                                                                                                                                                            a promise containing the field for the filter.

                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          setAppliedWorksheetsAsync

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            since
                                                                                                                                                            -

                                                                                                                                                            1.9.0 and Tableau 2022.2

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Parameters

                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • -
                                                                                                                                                              applyToWorksheets: Array<string>
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              list of worksheets to apply the filter on

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              • -
                                                                                                                                                            -

                                                                                                                                                            Returns Promise<Array<string>>

                                                                                                                                                            -

                                                                                                                                                            the list of worksheet names that have the filter applied

                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Legend

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Module
                                                                                                                                                            • -
                                                                                                                                                          • Object literal
                                                                                                                                                            • -
                                                                                                                                                          • Variable
                                                                                                                                                            • -
                                                                                                                                                          • Function
                                                                                                                                                            • -
                                                                                                                                                          • Function with type parameter
                                                                                                                                                            • -
                                                                                                                                                          • Index signature
                                                                                                                                                            • -
                                                                                                                                                          • Type alias
                                                                                                                                                            • -
                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Enumeration
                                                                                                                                                            • -
                                                                                                                                                          • Enumeration member
                                                                                                                                                            • -
                                                                                                                                                          • Property
                                                                                                                                                            • -
                                                                                                                                                          • Method
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Interface
                                                                                                                                                            • -
                                                                                                                                                          • Interface with type parameter
                                                                                                                                                            • -
                                                                                                                                                          • Constructor
                                                                                                                                                            • -
                                                                                                                                                          • Property
                                                                                                                                                            • -
                                                                                                                                                          • Method
                                                                                                                                                            • -
                                                                                                                                                          • Index signature
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Class
                                                                                                                                                            • -
                                                                                                                                                          • Class with type parameter
                                                                                                                                                            • -
                                                                                                                                                          • Constructor
                                                                                                                                                            • -
                                                                                                                                                          • Property
                                                                                                                                                            • -
                                                                                                                                                          • Method
                                                                                                                                                            • -
                                                                                                                                                          • Accessor
                                                                                                                                                            • -
                                                                                                                                                          • Index signature
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Inherited constructor
                                                                                                                                                            • -
                                                                                                                                                          • Inherited property
                                                                                                                                                            • -
                                                                                                                                                          • Inherited method
                                                                                                                                                            • -
                                                                                                                                                          • Inherited accessor
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Protected property
                                                                                                                                                            • -
                                                                                                                                                          • Protected method
                                                                                                                                                            • -
                                                                                                                                                          • Protected accessor
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Private property
                                                                                                                                                            • -
                                                                                                                                                          • Private method
                                                                                                                                                            • -
                                                                                                                                                          • Private accessor
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • Static property
                                                                                                                                                            • -
                                                                                                                                                          • Static method
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - - - - - \ No newline at end of file +HierarchicalFilter | Tableau Extensions API
                                                                                                                                                          Tableau Extensions API
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface HierarchicalFilter

                                                                                                                                                            A Hierarchical Filter +Hierarchical Filters are used when a hierarchical field is used as a filter on a cube database. +As an example, assume a hierarchical field in Product, named ByCategory. +ByCategory has the following five levels: Family, Category, Subcategory, Brand, Sku.

                                                                                                                                                            +

                                                                                                                                                            Extensions 1.10.0 and Tableau version 2022.3

                                                                                                                                                            +
                                                                                                                                                            interface HierarchicalFilter {
                                                                                                                                                                appliedValues: HierarchicalFilterDataValue[];
                                                                                                                                                                dimensionName: string;
                                                                                                                                                                fieldId: string;
                                                                                                                                                                fieldName: string;
                                                                                                                                                                filterType: FilterType;
                                                                                                                                                                hierarchyCaption: string;
                                                                                                                                                                isAllSelected: boolean;
                                                                                                                                                                levelDetails: HierarchicalLevelDetail[];
                                                                                                                                                                numberOfLevels: number;
                                                                                                                                                                worksheetName: string;
                                                                                                                                                                getAppliedWorksheetsAsync(): Promise<string[]>;
                                                                                                                                                                getFieldAsync(): Promise<Field>;
                                                                                                                                                                setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
                                                                                                                                                            }

                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            appliedValues +dimensionName +fieldId +fieldName +filterType +hierarchyCaption +isAllSelected +levelDetails +numberOfLevels +worksheetName +

                                                                                                                                                            Methods

                                                                                                                                                            getAppliedWorksheetsAsync +getFieldAsync +setAppliedWorksheetsAsync +

                                                                                                                                                            Properties

                                                                                                                                                            appliedValues: HierarchicalFilterDataValue[]

                                                                                                                                                            A list of values applied to this hierarchical filter.

                                                                                                                                                            +
                                                                                                                                                            dimensionName: string

                                                                                                                                                            The dimension name associated with the filter. In the ByCategory filter example, this would be 'Product'

                                                                                                                                                            +
                                                                                                                                                            fieldId: string

                                                                                                                                                            The id of the field being filtered.

                                                                                                                                                            +
                                                                                                                                                            fieldName: string

                                                                                                                                                            The name of the field being filtered. Note that this is the caption +as shown in the UI, and not the actual database field name.

                                                                                                                                                            +
                                                                                                                                                            filterType: FilterType

                                                                                                                                                            The type of the filter.

                                                                                                                                                            +
                                                                                                                                                            hierarchyCaption: string

                                                                                                                                                            The hierarchy caption associated with the filter. In the ByCategory filter example, this would be '[Product].[ByCategory]'

                                                                                                                                                            +
                                                                                                                                                            isAllSelected: boolean

                                                                                                                                                            True if all the values are selected for this filter. When 'All' is selected, +appliedValues returns an empty list.

                                                                                                                                                            +
                                                                                                                                                            levelDetails: HierarchicalLevelDetail[]

                                                                                                                                                            Details about each level in the hierarchical filter.

                                                                                                                                                            +
                                                                                                                                                            numberOfLevels: number

                                                                                                                                                            The number of levels in the hierarchical filter. In the ByCategory filter example, this would be 5

                                                                                                                                                            +
                                                                                                                                                            worksheetName: string

                                                                                                                                                            The parent worksheet.

                                                                                                                                                            +

                                                                                                                                                            Methods

                                                                                                                                                            • Returns Promise<string[]>

                                                                                                                                                              the list of worksheet names that have the filter applied.

                                                                                                                                                              +

                                                                                                                                                              1.9.0 and Tableau 2022.2

                                                                                                                                                              +

                                                                                                                                                            • Returns Promise<Field>

                                                                                                                                                              a promise containing the field for the filter.

                                                                                                                                                              +

                                                                                                                                                              1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                              +

                                                                                                                                                            • Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                              +

                                                                                                                                                              Parameters

                                                                                                                                                              • applyToWorksheets: string[]

                                                                                                                                                                list of worksheets to apply the filter on

                                                                                                                                                                +

                                                                                                                                                              Returns Promise<string[]>

                                                                                                                                                              the list of worksheet names that have the filter applied

                                                                                                                                                              +

                                                                                                                                                              1.9.0 and Tableau 2022.2

                                                                                                                                                              +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            Methods
                                                                                                                                                            diff --git a/website/static/api/interfaces/hierarchicalfilterdatavalue.html b/website/static/api/interfaces/hierarchicalfilterdatavalue.html index 635a6dcf..b6bfb925 100644 --- a/website/static/api/interfaces/hierarchicalfilterdatavalue.html +++ b/website/static/api/interfaces/hierarchicalfilterdatavalue.html @@ -1,260 +1,34 @@ - - - - - - HierarchicalFilterDataValue | Tableau Extensions - - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            - Options -
                                                                                                                                                            -
                                                                                                                                                            - All -
                                                                                                                                                              -
                                                                                                                                                            • Public
                                                                                                                                                              • -
                                                                                                                                                            • Public/Protected
                                                                                                                                                              • -
                                                                                                                                                            • All
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                            - - - - -
                                                                                                                                                            -
                                                                                                                                                            - Menu -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            Interface HierarchicalFilterDataValue

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            A selected value in a hierarchical filter

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Hierarchy

                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • - HierarchicalFilterDataValue -
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Properties

                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Properties

                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            hierarchicalPath

                                                                                                                                                            -
                                                                                                                                                            hierarchicalPath: string
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            returns
                                                                                                                                                            -

                                                                                                                                                            the path to this selected item. In the ByCategory example, the hierarchicalPath for a level 2 item could be - '[Outdoor & Sporting].[Bikes].[Kids' Bikes]'.

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            level

                                                                                                                                                            -
                                                                                                                                                            level: number
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            returns
                                                                                                                                                            -

                                                                                                                                                            the level of this selected item. In the ByCategory example, the level could be 0-4. - For '[Outdoor & Sporting].[Bikes].[Kids' Bikes]', the level is 2.

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            value

                                                                                                                                                            -
                                                                                                                                                            value: DataValue
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            returns
                                                                                                                                                            -

                                                                                                                                                            the DataValue of the seleted item

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Legend

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Module
                                                                                                                                                              • -
                                                                                                                                                            • Object literal
                                                                                                                                                              • -
                                                                                                                                                            • Variable
                                                                                                                                                              • -
                                                                                                                                                            • Function
                                                                                                                                                              • -
                                                                                                                                                            • Function with type parameter
                                                                                                                                                              • -
                                                                                                                                                            • Index signature
                                                                                                                                                              • -
                                                                                                                                                            • Type alias
                                                                                                                                                              • -
                                                                                                                                                            • Type alias with type parameter
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Enumeration
                                                                                                                                                              • -
                                                                                                                                                            • Enumeration member
                                                                                                                                                              • -
                                                                                                                                                            • Property
                                                                                                                                                              • -
                                                                                                                                                            • Method
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Interface
                                                                                                                                                              • -
                                                                                                                                                            • Interface with type parameter
                                                                                                                                                              • -
                                                                                                                                                            • Constructor
                                                                                                                                                              • -
                                                                                                                                                            • Property
                                                                                                                                                              • -
                                                                                                                                                            • Method
                                                                                                                                                              • -
                                                                                                                                                            • Index signature
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Class
                                                                                                                                                              • -
                                                                                                                                                            • Class with type parameter
                                                                                                                                                              • -
                                                                                                                                                            • Constructor
                                                                                                                                                              • -
                                                                                                                                                            • Property
                                                                                                                                                              • -
                                                                                                                                                            • Method
                                                                                                                                                              • -
                                                                                                                                                            • Accessor
                                                                                                                                                              • -
                                                                                                                                                            • Index signature
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Inherited constructor
                                                                                                                                                              • -
                                                                                                                                                            • Inherited property
                                                                                                                                                              • -
                                                                                                                                                            • Inherited method
                                                                                                                                                              • -
                                                                                                                                                            • Inherited accessor
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Protected property
                                                                                                                                                              • -
                                                                                                                                                            • Protected method
                                                                                                                                                              • -
                                                                                                                                                            • Protected accessor
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Private property
                                                                                                                                                              • -
                                                                                                                                                            • Private method
                                                                                                                                                              • -
                                                                                                                                                            • Private accessor
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            • Static property
                                                                                                                                                              • -
                                                                                                                                                            • Static method
                                                                                                                                                              • -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - - - - \ No newline at end of file +HierarchicalFilterDataValue | Tableau Extensions API
                                                                                                                                                            Tableau Extensions API
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface HierarchicalFilterDataValue

                                                                                                                                                              A selected value in a hierarchical filter

                                                                                                                                                              +
                                                                                                                                                              interface HierarchicalFilterDataValue {
                                                                                                                                                                  hierarchicalPath: string;
                                                                                                                                                                  level: number;
                                                                                                                                                                  value: DataValue;
                                                                                                                                                              }
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              hierarchicalPath +level +value +

                                                                                                                                                              Properties

                                                                                                                                                              hierarchicalPath: string

                                                                                                                                                              the path to this selected item. In the ByCategory example, the hierarchicalPath for a level 2 item could be +'[Outdoor & Sporting].[Bikes].[Kids' Bikes]'.

                                                                                                                                                              +
                                                                                                                                                              level: number

                                                                                                                                                              the level of this selected item. In the ByCategory example, the level could be 0-4. +For '[Outdoor & Sporting].[Bikes].[Kids' Bikes]', the level is 2.

                                                                                                                                                              +
                                                                                                                                                              value: DataValue

                                                                                                                                                              the DataValue of the seleted item

                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Properties
                                                                                                                                                              diff --git a/website/static/api/interfaces/hierarchicalleveldetail.html b/website/static/api/interfaces/hierarchicalleveldetail.html index 604c147e..b26d59c7 100644 --- a/website/static/api/interfaces/hierarchicalleveldetail.html +++ b/website/static/api/interfaces/hierarchicalleveldetail.html @@ -1,237 +1,30 @@ - - - - - - HierarchicalLevelDetail | Tableau Extensions - - - - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              - Options -
                                                                                                                                                              -
                                                                                                                                                              - All -
                                                                                                                                                                -
                                                                                                                                                              • Public
                                                                                                                                                                • -
                                                                                                                                                              • Public/Protected
                                                                                                                                                                • -
                                                                                                                                                              • All
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                              - - - - -
                                                                                                                                                              -
                                                                                                                                                              - Menu -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -

                                                                                                                                                              Interface HierarchicalLevelDetail

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Details about each level in a hierarchical filter

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Hierarchy

                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • - HierarchicalLevelDetail -
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Index

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Properties

                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Properties

                                                                                                                                                              -
                                                                                                                                                              - -

                                                                                                                                                              levelSelectionState

                                                                                                                                                              -
                                                                                                                                                              levelSelectionState: HierarchicalLevelSelectionState
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              returns
                                                                                                                                                              -

                                                                                                                                                              the level selection state

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -

                                                                                                                                                              name

                                                                                                                                                              -
                                                                                                                                                              name: string
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              returns
                                                                                                                                                              -

                                                                                                                                                              the level name. In the ByCategory example, the name could be 'Family', 'Category', 'Subcategory', 'Brand', or 'Sku'.

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Legend

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Module
                                                                                                                                                                • -
                                                                                                                                                              • Object literal
                                                                                                                                                                • -
                                                                                                                                                              • Variable
                                                                                                                                                                • -
                                                                                                                                                              • Function
                                                                                                                                                                • -
                                                                                                                                                              • Function with type parameter
                                                                                                                                                                • -
                                                                                                                                                              • Index signature
                                                                                                                                                                • -
                                                                                                                                                              • Type alias
                                                                                                                                                                • -
                                                                                                                                                              • Type alias with type parameter
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Enumeration
                                                                                                                                                                • -
                                                                                                                                                              • Enumeration member
                                                                                                                                                                • -
                                                                                                                                                              • Property
                                                                                                                                                                • -
                                                                                                                                                              • Method
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Interface
                                                                                                                                                                • -
                                                                                                                                                              • Interface with type parameter
                                                                                                                                                                • -
                                                                                                                                                              • Constructor
                                                                                                                                                                • -
                                                                                                                                                              • Property
                                                                                                                                                                • -
                                                                                                                                                              • Method
                                                                                                                                                                • -
                                                                                                                                                              • Index signature
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Class
                                                                                                                                                                • -
                                                                                                                                                              • Class with type parameter
                                                                                                                                                                • -
                                                                                                                                                              • Constructor
                                                                                                                                                                • -
                                                                                                                                                              • Property
                                                                                                                                                                • -
                                                                                                                                                              • Method
                                                                                                                                                                • -
                                                                                                                                                              • Accessor
                                                                                                                                                                • -
                                                                                                                                                              • Index signature
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Inherited constructor
                                                                                                                                                                • -
                                                                                                                                                              • Inherited property
                                                                                                                                                                • -
                                                                                                                                                              • Inherited method
                                                                                                                                                                • -
                                                                                                                                                              • Inherited accessor
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Protected property
                                                                                                                                                                • -
                                                                                                                                                              • Protected method
                                                                                                                                                                • -
                                                                                                                                                              • Protected accessor
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Private property
                                                                                                                                                                • -
                                                                                                                                                              • Private method
                                                                                                                                                                • -
                                                                                                                                                              • Private accessor
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • Static property
                                                                                                                                                                • -
                                                                                                                                                              • Static method
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - - - - \ No newline at end of file +HierarchicalLevelDetail | Tableau Extensions API
                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface HierarchicalLevelDetail

                                                                                                                                                                Details about each level in a hierarchical filter

                                                                                                                                                                +
                                                                                                                                                                interface HierarchicalLevelDetail {
                                                                                                                                                                    levelSelectionState: HierarchicalLevelSelectionState;
                                                                                                                                                                    name: string;
                                                                                                                                                                }
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                levelSelectionState +name +

                                                                                                                                                                Properties

                                                                                                                                                                levelSelectionState: HierarchicalLevelSelectionState

                                                                                                                                                                the level selection state

                                                                                                                                                                +
                                                                                                                                                                name: string

                                                                                                                                                                the level name. In the ByCategory example, the name could be 'Family', 'Category', 'Subcategory', 'Brand', or 'Sku'.

                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Properties
                                                                                                                                                                diff --git a/website/static/api/interfaces/hierarchicallevels.html b/website/static/api/interfaces/hierarchicallevels.html index e6c41f88..85b86678 100644 --- a/website/static/api/interfaces/hierarchicallevels.html +++ b/website/static/api/interfaces/hierarchicallevels.html @@ -1,214 +1,28 @@ - - - - - - HierarchicalLevels | Tableau Extensions - - - - - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                - Options -
                                                                                                                                                                -
                                                                                                                                                                - All -
                                                                                                                                                                  -
                                                                                                                                                                • Public
                                                                                                                                                                  • -
                                                                                                                                                                • Public/Protected
                                                                                                                                                                  • -
                                                                                                                                                                • All
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                - - - - -
                                                                                                                                                                -
                                                                                                                                                                - Menu -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - -

                                                                                                                                                                Interface HierarchicalLevels

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Levels to apply to a hierarchical filter

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                since
                                                                                                                                                                -

                                                                                                                                                                Extensions 1.10.0 and Tableau version 2022.3

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Hierarchy

                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • - HierarchicalLevels -
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Index

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Properties

                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Properties

                                                                                                                                                                -
                                                                                                                                                                - -

                                                                                                                                                                levels

                                                                                                                                                                -
                                                                                                                                                                levels: Array<string>
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Legend

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Module
                                                                                                                                                                  • -
                                                                                                                                                                • Object literal
                                                                                                                                                                  • -
                                                                                                                                                                • Variable
                                                                                                                                                                  • -
                                                                                                                                                                • Function
                                                                                                                                                                  • -
                                                                                                                                                                • Function with type parameter
                                                                                                                                                                  • -
                                                                                                                                                                • Index signature
                                                                                                                                                                  • -
                                                                                                                                                                • Type alias
                                                                                                                                                                  • -
                                                                                                                                                                • Type alias with type parameter
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Enumeration
                                                                                                                                                                  • -
                                                                                                                                                                • Enumeration member
                                                                                                                                                                  • -
                                                                                                                                                                • Property
                                                                                                                                                                  • -
                                                                                                                                                                • Method
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Interface
                                                                                                                                                                  • -
                                                                                                                                                                • Interface with type parameter
                                                                                                                                                                  • -
                                                                                                                                                                • Constructor
                                                                                                                                                                  • -
                                                                                                                                                                • Property
                                                                                                                                                                  • -
                                                                                                                                                                • Method
                                                                                                                                                                  • -
                                                                                                                                                                • Index signature
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Class
                                                                                                                                                                  • -
                                                                                                                                                                • Class with type parameter
                                                                                                                                                                  • -
                                                                                                                                                                • Constructor
                                                                                                                                                                  • -
                                                                                                                                                                • Property
                                                                                                                                                                  • -
                                                                                                                                                                • Method
                                                                                                                                                                  • -
                                                                                                                                                                • Accessor
                                                                                                                                                                  • -
                                                                                                                                                                • Index signature
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Inherited constructor
                                                                                                                                                                  • -
                                                                                                                                                                • Inherited property
                                                                                                                                                                  • -
                                                                                                                                                                • Inherited method
                                                                                                                                                                  • -
                                                                                                                                                                • Inherited accessor
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Protected property
                                                                                                                                                                  • -
                                                                                                                                                                • Protected method
                                                                                                                                                                  • -
                                                                                                                                                                • Protected accessor
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Private property
                                                                                                                                                                  • -
                                                                                                                                                                • Private method
                                                                                                                                                                  • -
                                                                                                                                                                • Private accessor
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • Static property
                                                                                                                                                                  • -
                                                                                                                                                                • Static method
                                                                                                                                                                  • -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - - - - - \ No newline at end of file +HierarchicalLevels | Tableau Extensions API
                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Interface HierarchicalLevels

                                                                                                                                                                  Levels to apply to a hierarchical filter

                                                                                                                                                                  +

                                                                                                                                                                  Extensions 1.10.0 and Tableau version 2022.3

                                                                                                                                                                  +
                                                                                                                                                                  interface HierarchicalLevels {
                                                                                                                                                                      levels: string[];
                                                                                                                                                                  }
                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  levels +

                                                                                                                                                                  Properties

                                                                                                                                                                  levels: string[]

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Properties
                                                                                                                                                                  diff --git a/website/static/api/interfaces/logicaltable.html b/website/static/api/interfaces/logicaltable.html index fce865ca..ce1f6fe3 100644 --- a/website/static/api/interfaces/logicaltable.html +++ b/website/static/api/interfaces/logicaltable.html @@ -1,226 +1,29 @@ - - - - - - LogicalTable | Tableau Extensions - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - Options -
                                                                                                                                                                  -
                                                                                                                                                                  - All -
                                                                                                                                                                    -
                                                                                                                                                                  • Public
                                                                                                                                                                    • -
                                                                                                                                                                  • Public/Protected
                                                                                                                                                                    • -
                                                                                                                                                                  • All
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - Menu -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  Interface LogicalTable

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  since
                                                                                                                                                                  -

                                                                                                                                                                  1.4.0 - Represents a logical table in a data source or a logical table used in a worksheet

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Hierarchy

                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • - LogicalTable -
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Index

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Properties

                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Properties

                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  caption

                                                                                                                                                                  -
                                                                                                                                                                  caption: string
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  id

                                                                                                                                                                  -
                                                                                                                                                                  id: string
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Legend

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Module
                                                                                                                                                                    • -
                                                                                                                                                                  • Object literal
                                                                                                                                                                    • -
                                                                                                                                                                  • Variable
                                                                                                                                                                    • -
                                                                                                                                                                  • Function
                                                                                                                                                                    • -
                                                                                                                                                                  • Function with type parameter
                                                                                                                                                                    • -
                                                                                                                                                                  • Index signature
                                                                                                                                                                    • -
                                                                                                                                                                  • Type alias
                                                                                                                                                                    • -
                                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Enumeration
                                                                                                                                                                    • -
                                                                                                                                                                  • Enumeration member
                                                                                                                                                                    • -
                                                                                                                                                                  • Property
                                                                                                                                                                    • -
                                                                                                                                                                  • Method
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Interface
                                                                                                                                                                    • -
                                                                                                                                                                  • Interface with type parameter
                                                                                                                                                                    • -
                                                                                                                                                                  • Constructor
                                                                                                                                                                    • -
                                                                                                                                                                  • Property
                                                                                                                                                                    • -
                                                                                                                                                                  • Method
                                                                                                                                                                    • -
                                                                                                                                                                  • Index signature
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Class
                                                                                                                                                                    • -
                                                                                                                                                                  • Class with type parameter
                                                                                                                                                                    • -
                                                                                                                                                                  • Constructor
                                                                                                                                                                    • -
                                                                                                                                                                  • Property
                                                                                                                                                                    • -
                                                                                                                                                                  • Method
                                                                                                                                                                    • -
                                                                                                                                                                  • Accessor
                                                                                                                                                                    • -
                                                                                                                                                                  • Index signature
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Inherited constructor
                                                                                                                                                                    • -
                                                                                                                                                                  • Inherited property
                                                                                                                                                                    • -
                                                                                                                                                                  • Inherited method
                                                                                                                                                                    • -
                                                                                                                                                                  • Inherited accessor
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Protected property
                                                                                                                                                                    • -
                                                                                                                                                                  • Protected method
                                                                                                                                                                    • -
                                                                                                                                                                  • Protected accessor
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Private property
                                                                                                                                                                    • -
                                                                                                                                                                  • Private method
                                                                                                                                                                    • -
                                                                                                                                                                  • Private accessor
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • Static property
                                                                                                                                                                    • -
                                                                                                                                                                  • Static method
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - - \ No newline at end of file +LogicalTable | Tableau Extensions API
                                                                                                                                                                  Tableau Extensions API
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface LogicalTable

                                                                                                                                                                    1.4.0 +Represents a logical table in a data source or a logical table used in a worksheet

                                                                                                                                                                    +
                                                                                                                                                                    interface LogicalTable {
                                                                                                                                                                        caption: string;
                                                                                                                                                                        id: string;
                                                                                                                                                                    }
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    caption +id +

                                                                                                                                                                    Properties

                                                                                                                                                                    caption: string
                                                                                                                                                                    id: string

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    diff --git a/website/static/api/interfaces/markinfo.html b/website/static/api/interfaces/markinfo.html index ea5e0b38..5e78de62 100644 --- a/website/static/api/interfaces/markinfo.html +++ b/website/static/api/interfaces/markinfo.html @@ -1,262 +1,32 @@ - - - - - - MarkInfo | Tableau Extensions - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - Options -
                                                                                                                                                                    -
                                                                                                                                                                    - All -
                                                                                                                                                                      -
                                                                                                                                                                    • Public
                                                                                                                                                                      • -
                                                                                                                                                                    • Public/Protected
                                                                                                                                                                      • -
                                                                                                                                                                    • All
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - Menu -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -

                                                                                                                                                                    Interface MarkInfo

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Represents a mark in a worksheet.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Hierarchy

                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • - MarkInfo -
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Index

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Properties

                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Properties

                                                                                                                                                                    -
                                                                                                                                                                    - -

                                                                                                                                                                    color

                                                                                                                                                                    -
                                                                                                                                                                    color: string
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    notimplemented
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    returns
                                                                                                                                                                    -

                                                                                                                                                                    The RGBA value of this mark.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -

                                                                                                                                                                    Optional tupleId

                                                                                                                                                                    -
                                                                                                                                                                    tupleId: undefined | number
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    returns
                                                                                                                                                                    -

                                                                                                                                                                    Unique tuple representing this mark in a drawn visualization.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -

                                                                                                                                                                    type

                                                                                                                                                                    -
                                                                                                                                                                    type: MarkType
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    notimplemented
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    returns
                                                                                                                                                                    -

                                                                                                                                                                    The type of this mark.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    Legend

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Module
                                                                                                                                                                      • -
                                                                                                                                                                    • Object literal
                                                                                                                                                                      • -
                                                                                                                                                                    • Variable
                                                                                                                                                                      • -
                                                                                                                                                                    • Function
                                                                                                                                                                      • -
                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                      • -
                                                                                                                                                                    • Index signature
                                                                                                                                                                      • -
                                                                                                                                                                    • Type alias
                                                                                                                                                                      • -
                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Enumeration
                                                                                                                                                                      • -
                                                                                                                                                                    • Enumeration member
                                                                                                                                                                      • -
                                                                                                                                                                    • Property
                                                                                                                                                                      • -
                                                                                                                                                                    • Method
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Interface
                                                                                                                                                                      • -
                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                      • -
                                                                                                                                                                    • Constructor
                                                                                                                                                                      • -
                                                                                                                                                                    • Property
                                                                                                                                                                      • -
                                                                                                                                                                    • Method
                                                                                                                                                                      • -
                                                                                                                                                                    • Index signature
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Class
                                                                                                                                                                      • -
                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                      • -
                                                                                                                                                                    • Constructor
                                                                                                                                                                      • -
                                                                                                                                                                    • Property
                                                                                                                                                                      • -
                                                                                                                                                                    • Method
                                                                                                                                                                      • -
                                                                                                                                                                    • Accessor
                                                                                                                                                                      • -
                                                                                                                                                                    • Index signature
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                      • -
                                                                                                                                                                    • Inherited property
                                                                                                                                                                      • -
                                                                                                                                                                    • Inherited method
                                                                                                                                                                      • -
                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Protected property
                                                                                                                                                                      • -
                                                                                                                                                                    • Protected method
                                                                                                                                                                      • -
                                                                                                                                                                    • Protected accessor
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Private property
                                                                                                                                                                      • -
                                                                                                                                                                    • Private method
                                                                                                                                                                      • -
                                                                                                                                                                    • Private accessor
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                      -
                                                                                                                                                                    • Static property
                                                                                                                                                                      • -
                                                                                                                                                                    • Static method
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - - - - \ No newline at end of file +MarkInfo | Tableau Extensions API
                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface MarkInfo

                                                                                                                                                                      Represents a mark in a worksheet.

                                                                                                                                                                      +
                                                                                                                                                                      interface MarkInfo {
                                                                                                                                                                          color: string;
                                                                                                                                                                          tupleId?: number;
                                                                                                                                                                          type: MarkType;
                                                                                                                                                                      }
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      color +tupleId? +type +

                                                                                                                                                                      Properties

                                                                                                                                                                      color: string

                                                                                                                                                                      The RGBA value of this mark.

                                                                                                                                                                      +
                                                                                                                                                                      tupleId?: number

                                                                                                                                                                      Unique tuple representing this mark in a drawn visualization.

                                                                                                                                                                      +
                                                                                                                                                                      type: MarkType

                                                                                                                                                                      The type of this mark.

                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Properties
                                                                                                                                                                      diff --git a/website/static/api/interfaces/markscollection.html b/website/static/api/interfaces/markscollection.html index a17eff62..1237db8d 100644 --- a/website/static/api/interfaces/markscollection.html +++ b/website/static/api/interfaces/markscollection.html @@ -1,219 +1,31 @@ - - - - - - MarksCollection | Tableau Extensions - - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - Options -
                                                                                                                                                                      -
                                                                                                                                                                      - All -
                                                                                                                                                                        -
                                                                                                                                                                      • Public
                                                                                                                                                                        • -
                                                                                                                                                                      • Public/Protected
                                                                                                                                                                        • -
                                                                                                                                                                      • All
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - Menu -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -

                                                                                                                                                                      Interface MarksCollection

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Represents a collection of marks on a viz. This collection could be - marks that are either selected or highlighted.

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Hierarchy

                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • - MarksCollection -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Index

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Properties

                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Properties

                                                                                                                                                                      -
                                                                                                                                                                      - -

                                                                                                                                                                      data

                                                                                                                                                                      -
                                                                                                                                                                      data: Array<DataTable>
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      returns
                                                                                                                                                                      -

                                                                                                                                                                      A collection of data tables. Each row in each data table represents a single - mark on the viz. Since marks can contain columns different than the columns of another mark, - for example, a dual axis chart, each table represents one specific schema of a mark.

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Legend

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Module
                                                                                                                                                                        • -
                                                                                                                                                                      • Object literal
                                                                                                                                                                        • -
                                                                                                                                                                      • Variable
                                                                                                                                                                        • -
                                                                                                                                                                      • Function
                                                                                                                                                                        • -
                                                                                                                                                                      • Function with type parameter
                                                                                                                                                                        • -
                                                                                                                                                                      • Index signature
                                                                                                                                                                        • -
                                                                                                                                                                      • Type alias
                                                                                                                                                                        • -
                                                                                                                                                                      • Type alias with type parameter
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Enumeration
                                                                                                                                                                        • -
                                                                                                                                                                      • Enumeration member
                                                                                                                                                                        • -
                                                                                                                                                                      • Property
                                                                                                                                                                        • -
                                                                                                                                                                      • Method
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Interface
                                                                                                                                                                        • -
                                                                                                                                                                      • Interface with type parameter
                                                                                                                                                                        • -
                                                                                                                                                                      • Constructor
                                                                                                                                                                        • -
                                                                                                                                                                      • Property
                                                                                                                                                                        • -
                                                                                                                                                                      • Method
                                                                                                                                                                        • -
                                                                                                                                                                      • Index signature
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Class
                                                                                                                                                                        • -
                                                                                                                                                                      • Class with type parameter
                                                                                                                                                                        • -
                                                                                                                                                                      • Constructor
                                                                                                                                                                        • -
                                                                                                                                                                      • Property
                                                                                                                                                                        • -
                                                                                                                                                                      • Method
                                                                                                                                                                        • -
                                                                                                                                                                      • Accessor
                                                                                                                                                                        • -
                                                                                                                                                                      • Index signature
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Inherited constructor
                                                                                                                                                                        • -
                                                                                                                                                                      • Inherited property
                                                                                                                                                                        • -
                                                                                                                                                                      • Inherited method
                                                                                                                                                                        • -
                                                                                                                                                                      • Inherited accessor
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Protected property
                                                                                                                                                                        • -
                                                                                                                                                                      • Protected method
                                                                                                                                                                        • -
                                                                                                                                                                      • Protected accessor
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Private property
                                                                                                                                                                        • -
                                                                                                                                                                      • Private method
                                                                                                                                                                        • -
                                                                                                                                                                      • Private accessor
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                        -
                                                                                                                                                                      • Static property
                                                                                                                                                                        • -
                                                                                                                                                                      • Static method
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - - \ No newline at end of file +MarksCollection | Tableau Extensions API
                                                                                                                                                                      Tableau Extensions API
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface MarksCollection

                                                                                                                                                                        Represents a collection of marks on a viz. This collection could be +marks that are either selected or highlighted.

                                                                                                                                                                        +
                                                                                                                                                                        interface MarksCollection {
                                                                                                                                                                            data: DataTable[];
                                                                                                                                                                        }
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        data +

                                                                                                                                                                        Properties

                                                                                                                                                                        data: DataTable[]

                                                                                                                                                                        A collection of data tables. Each row in each data table represents a single +mark on the viz. Since marks can contain columns different than the columns of another mark, +for example, a dual axis chart, each table represents one specific schema of a mark.

                                                                                                                                                                        +

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility

                                                                                                                                                                        On This Page

                                                                                                                                                                        Properties
                                                                                                                                                                        diff --git a/website/static/api/interfaces/marksselectedevent.html b/website/static/api/interfaces/marksselectedevent.html index f0b90ade..1a0608d5 100644 --- a/website/static/api/interfaces/marksselectedevent.html +++ b/website/static/api/interfaces/marksselectedevent.html @@ -1,298 +1,34 @@ - - - - - - MarksSelectedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        - Options -
                                                                                                                                                                        -
                                                                                                                                                                        - All -
                                                                                                                                                                          -
                                                                                                                                                                        • Public
                                                                                                                                                                          • -
                                                                                                                                                                        • Public/Protected
                                                                                                                                                                          • -
                                                                                                                                                                        • All
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - Menu -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - -

                                                                                                                                                                        Interface MarksSelectedEvent

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        An event which is raised when marks are selected on a worksheet.

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Hierarchy

                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Index

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Properties

                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Methods

                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Properties

                                                                                                                                                                        -
                                                                                                                                                                        - -

                                                                                                                                                                        sheet

                                                                                                                                                                        -
                                                                                                                                                                        sheet: Sheet
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        returns
                                                                                                                                                                        -

                                                                                                                                                                        The sheet which was the source of this event.

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - -

                                                                                                                                                                        type

                                                                                                                                                                        -
                                                                                                                                                                        type: TableauEventType
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        returns
                                                                                                                                                                        -

                                                                                                                                                                        The type of event which this class is representing.

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - -

                                                                                                                                                                        worksheet

                                                                                                                                                                        -
                                                                                                                                                                        worksheet: Worksheet
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        returns
                                                                                                                                                                        -

                                                                                                                                                                        The worksheet which was the source of this event.

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Methods

                                                                                                                                                                        -
                                                                                                                                                                        - -

                                                                                                                                                                        getMarksAsync

                                                                                                                                                                        - -
                                                                                                                                                                          -
                                                                                                                                                                        • - -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Returns Promise<MarksCollection>

                                                                                                                                                                          -

                                                                                                                                                                          The collection of Marks that were selected.

                                                                                                                                                                          -
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -

                                                                                                                                                                        Legend

                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Module
                                                                                                                                                                          • -
                                                                                                                                                                        • Object literal
                                                                                                                                                                          • -
                                                                                                                                                                        • Variable
                                                                                                                                                                          • -
                                                                                                                                                                        • Function
                                                                                                                                                                          • -
                                                                                                                                                                        • Function with type parameter
                                                                                                                                                                          • -
                                                                                                                                                                        • Index signature
                                                                                                                                                                          • -
                                                                                                                                                                        • Type alias
                                                                                                                                                                          • -
                                                                                                                                                                        • Type alias with type parameter
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Enumeration
                                                                                                                                                                          • -
                                                                                                                                                                        • Enumeration member
                                                                                                                                                                          • -
                                                                                                                                                                        • Property
                                                                                                                                                                          • -
                                                                                                                                                                        • Method
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Interface
                                                                                                                                                                          • -
                                                                                                                                                                        • Interface with type parameter
                                                                                                                                                                          • -
                                                                                                                                                                        • Constructor
                                                                                                                                                                          • -
                                                                                                                                                                        • Property
                                                                                                                                                                          • -
                                                                                                                                                                        • Method
                                                                                                                                                                          • -
                                                                                                                                                                        • Index signature
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Class
                                                                                                                                                                          • -
                                                                                                                                                                        • Class with type parameter
                                                                                                                                                                          • -
                                                                                                                                                                        • Constructor
                                                                                                                                                                          • -
                                                                                                                                                                        • Property
                                                                                                                                                                          • -
                                                                                                                                                                        • Method
                                                                                                                                                                          • -
                                                                                                                                                                        • Accessor
                                                                                                                                                                          • -
                                                                                                                                                                        • Index signature
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Inherited constructor
                                                                                                                                                                          • -
                                                                                                                                                                        • Inherited property
                                                                                                                                                                          • -
                                                                                                                                                                        • Inherited method
                                                                                                                                                                          • -
                                                                                                                                                                        • Inherited accessor
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Protected property
                                                                                                                                                                          • -
                                                                                                                                                                        • Protected method
                                                                                                                                                                          • -
                                                                                                                                                                        • Protected accessor
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Private property
                                                                                                                                                                          • -
                                                                                                                                                                        • Private method
                                                                                                                                                                          • -
                                                                                                                                                                        • Private accessor
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                          -
                                                                                                                                                                        • Static property
                                                                                                                                                                          • -
                                                                                                                                                                        • Static method
                                                                                                                                                                          • -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        -
                                                                                                                                                                        - - - - - \ No newline at end of file +MarksSelectedEvent | Tableau Extensions API
                                                                                                                                                                        Tableau Extensions API
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Interface MarksSelectedEvent

                                                                                                                                                                          An event which is raised when marks are selected on a worksheet.

                                                                                                                                                                          +
                                                                                                                                                                          interface MarksSelectedEvent {
                                                                                                                                                                              sheet: Sheet;
                                                                                                                                                                              type: TableauEventType;
                                                                                                                                                                              worksheet: Worksheet;
                                                                                                                                                                              getMarksAsync(): Promise<MarksCollection>;
                                                                                                                                                                          }

                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                          Index

                                                                                                                                                                          Properties

                                                                                                                                                                          sheet +type +worksheet +

                                                                                                                                                                          Methods

                                                                                                                                                                          getMarksAsync +

                                                                                                                                                                          Properties

                                                                                                                                                                          sheet: Sheet

                                                                                                                                                                          The sheet which was the source of this event.

                                                                                                                                                                          +
                                                                                                                                                                          type: TableauEventType

                                                                                                                                                                          The type of event which this class is representing.

                                                                                                                                                                          +
                                                                                                                                                                          worksheet: Worksheet

                                                                                                                                                                          The worksheet which was the source of this event.

                                                                                                                                                                          +

                                                                                                                                                                          Methods

                                                                                                                                                                          • Returns Promise<MarksCollection>

                                                                                                                                                                            The collection of Marks that were selected.

                                                                                                                                                                            +

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Properties
                                                                                                                                                                          Methods
                                                                                                                                                                          diff --git a/website/static/api/interfaces/marksspecification.html b/website/static/api/interfaces/marksspecification.html index 35229cba..c79bcb36 100644 --- a/website/static/api/interfaces/marksspecification.html +++ b/website/static/api/interfaces/marksspecification.html @@ -1,226 +1,29 @@ - - - - - - MarksSpecification | Tableau Extensions - - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - Options -
                                                                                                                                                                          -
                                                                                                                                                                          - All -
                                                                                                                                                                            -
                                                                                                                                                                          • Public
                                                                                                                                                                            • -
                                                                                                                                                                          • Public/Protected
                                                                                                                                                                            • -
                                                                                                                                                                          • All
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - Menu -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          Interface MarksSpecification

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          since
                                                                                                                                                                          -

                                                                                                                                                                          1.11.0 - Represents a collection of fields on various encodings for a single marks card

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Hierarchy

                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • - MarksSpecification -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Index

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Properties

                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Properties

                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          encodings

                                                                                                                                                                          -
                                                                                                                                                                          encodings: Encoding[]
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          primitiveType

                                                                                                                                                                          -
                                                                                                                                                                          primitiveType: MarkType
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Legend

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Module
                                                                                                                                                                            • -
                                                                                                                                                                          • Object literal
                                                                                                                                                                            • -
                                                                                                                                                                          • Variable
                                                                                                                                                                            • -
                                                                                                                                                                          • Function
                                                                                                                                                                            • -
                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                            • -
                                                                                                                                                                          • Index signature
                                                                                                                                                                            • -
                                                                                                                                                                          • Type alias
                                                                                                                                                                            • -
                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Enumeration
                                                                                                                                                                            • -
                                                                                                                                                                          • Enumeration member
                                                                                                                                                                            • -
                                                                                                                                                                          • Property
                                                                                                                                                                            • -
                                                                                                                                                                          • Method
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Interface
                                                                                                                                                                            • -
                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                            • -
                                                                                                                                                                          • Constructor
                                                                                                                                                                            • -
                                                                                                                                                                          • Property
                                                                                                                                                                            • -
                                                                                                                                                                          • Method
                                                                                                                                                                            • -
                                                                                                                                                                          • Index signature
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Class
                                                                                                                                                                            • -
                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                            • -
                                                                                                                                                                          • Constructor
                                                                                                                                                                            • -
                                                                                                                                                                          • Property
                                                                                                                                                                            • -
                                                                                                                                                                          • Method
                                                                                                                                                                            • -
                                                                                                                                                                          • Accessor
                                                                                                                                                                            • -
                                                                                                                                                                          • Index signature
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                            • -
                                                                                                                                                                          • Inherited property
                                                                                                                                                                            • -
                                                                                                                                                                          • Inherited method
                                                                                                                                                                            • -
                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Protected property
                                                                                                                                                                            • -
                                                                                                                                                                          • Protected method
                                                                                                                                                                            • -
                                                                                                                                                                          • Protected accessor
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Private property
                                                                                                                                                                            • -
                                                                                                                                                                          • Private method
                                                                                                                                                                            • -
                                                                                                                                                                          • Private accessor
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • Static property
                                                                                                                                                                            • -
                                                                                                                                                                          • Static method
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - - \ No newline at end of file +MarksSpecification | Tableau Extensions API
                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface MarksSpecification

                                                                                                                                                                            1.11.0 +Represents a collection of fields on various encodings for a single marks card

                                                                                                                                                                            +
                                                                                                                                                                            interface MarksSpecification {
                                                                                                                                                                                encodings: Encoding[];
                                                                                                                                                                                primitiveType: MarkType;
                                                                                                                                                                            }
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            encodings +primitiveType +

                                                                                                                                                                            Properties

                                                                                                                                                                            encodings: Encoding[]
                                                                                                                                                                            primitiveType: MarkType

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            On This Page

                                                                                                                                                                            Properties
                                                                                                                                                                            diff --git a/website/static/api/interfaces/parameter.html b/website/static/api/interfaces/parameter.html index 6a17f155..2c686d94 100644 --- a/website/static/api/interfaces/parameter.html +++ b/website/static/api/interfaces/parameter.html @@ -1,483 +1,96 @@ - - - - - - Parameter | Tableau Extensions - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - Options -
                                                                                                                                                                            -
                                                                                                                                                                            - All -
                                                                                                                                                                              -
                                                                                                                                                                            • Public
                                                                                                                                                                              • -
                                                                                                                                                                            • Public/Protected
                                                                                                                                                                              • -
                                                                                                                                                                            • All
                                                                                                                                                                              • -
                                                                                                                                                                            -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - Menu -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            Interface Parameter

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Represents a parameter in Tableau and provides ways to introspect the parameter and change its values.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Hierarchy

                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Index

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Properties

                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Methods

                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Properties

                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            allowableValues

                                                                                                                                                                            -
                                                                                                                                                                            allowableValues: ParameterDomainRestriction
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            returns
                                                                                                                                                                            -

                                                                                                                                                                            The allowable set of values this parameter can take.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            currentValue

                                                                                                                                                                            -
                                                                                                                                                                            currentValue: DataValue
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            returns
                                                                                                                                                                            -

                                                                                                                                                                            DataValue representing the current value of the parameter.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            dataType

                                                                                                                                                                            -
                                                                                                                                                                            dataType: DataType
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            returns
                                                                                                                                                                            -

                                                                                                                                                                            The type of data this parameter holds.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            id

                                                                                                                                                                            -
                                                                                                                                                                            id: string
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            returns
                                                                                                                                                                            -

                                                                                                                                                                            A unique identifier for this Parameter.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            name

                                                                                                                                                                            -
                                                                                                                                                                            name: string
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            returns
                                                                                                                                                                            -

                                                                                                                                                                            The display name of this parameter.

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Methods

                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            addEventListener

                                                                                                                                                                            - -
                                                                                                                                                                              -
                                                                                                                                                                            • - -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Adds a new event listener to the object. If this object does not support the specified eventType, - the method throws an exception. - The following table shows the event types supported by objects.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              objecteventType
                                                                                                                                                                              WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                              ParameterParameterChanged
                                                                                                                                                                              SettingsSettingsChanged
                                                                                                                                                                              DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Parameters

                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • -
                                                                                                                                                                                eventType: TableauEventType
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                The type of event to register for. The type of event is a TableauEventType enumeration.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              • -
                                                                                                                                                                                handler: TableauEventHandlerFn
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                The function which will be called when an event happens.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -

                                                                                                                                                                              Returns TableauEventUnregisterFn

                                                                                                                                                                              -

                                                                                                                                                                              A helper function which can be called to remove this registration.

                                                                                                                                                                              -

                                                                                                                                                                              The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged). - When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers - the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.

                                                                                                                                                                              - 
                                                                                                                                                                              // Add an event listener for the selection changed event on this sheet.
-// Assigning the event to a variable just to make the example fit on the page here.
-const markSelection = tableau.TableauEventType.MarkSelectionChanged;
-//
-unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
-// When the selection changes, reload the data
-loadSelectedMarks(worksheetName);
-});
+Parameter | Tableau Extensions API
                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                Interface Parameter
                                                                                                                                                                                Represents a parameter in Tableau and provides ways to introspect the parameter and change its values.
                                                                                                                                                                                
+
                                                                                                                                                                                interface Parameter {
                                                                                                                                                                                    allowableValues: ParameterDomainRestriction;
                                                                                                                                                                                    currentValue: DataValue;
                                                                                                                                                                                    dataType: DataType;
                                                                                                                                                                                    id: string;
                                                                                                                                                                                    name: string;
                                                                                                                                                                                    addEventListener(
                                                                                                                                                                                        eventType: TableauEventType,
                                                                                                                                                                                        handler: TableauEventHandlerFn,
                                                                                                                                                                                    ): TableauEventUnregisterFn;
                                                                                                                                                                                    changeValueAsync(
                                                                                                                                                                                        newValue: string | number | boolean | Date,
                                                                                                                                                                                    ): Promise<DataValue>;
                                                                                                                                                                                    removeEventListener(
                                                                                                                                                                                        eventType: TableauEventType,
                                                                                                                                                                                        handler: TableauEventHandlerFn,
                                                                                                                                                                                    ): boolean;
                                                                                                                                                                                }
                                                                                                                                                                                Hierarchy (View Summary)
                                                                                                                                                                                Index
                                                                                                                                                                                Properties
                                                                                                                                                                                allowableValues
+currentValue
+dataType
+id
+name
+
                                                                                                                                                                                Methods
                                                                                                                                                                                addEventListener
+changeValueAsync
+removeEventListener
+
                                                                                                                                                                                Properties
                                                                                                                                                                                allowableValues: ParameterDomainRestriction
                                                                                                                                                                                The allowable set of values this parameter can take.
                                                                                                                                                                                
+
                                                                                                                                                                                currentValue: DataValue
                                                                                                                                                                                DataValue representing the current value of the parameter.
                                                                                                                                                                                
+
                                                                                                                                                                                dataType: DataType
                                                                                                                                                                                The type of data this parameter holds.
                                                                                                                                                                                
+
                                                                                                                                                                                id: string
                                                                                                                                                                                A unique identifier for this Parameter.
                                                                                                                                                                                
+
                                                                                                                                                                                name: string
                                                                                                                                                                                The display name of this parameter.
                                                                                                                                                                                
+
                                                                                                                                                                                Methods
                                                                                                                                                                                • Adds a new event listener to the object. If this object does not support the specified eventType,
+the method throws an exception.
+The following table shows the event types supported by objects.
                                                                                                                                                                                  
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                  objecteventType
                                                                                                                                                                                  WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                                  ParameterParameterChanged
                                                                                                                                                                                  SettingsSettingsChanged
                                                                                                                                                                                  DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                                  
+
                                                                                                                                                                                  Parameters
                                                                                                                                                                                  • eventType: TableauEventType
                                                                                                                                                                                    The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                                                                                    
+
                                                                                                                                                                                  • handler: TableauEventHandlerFn
                                                                                                                                                                                    The function which will be called when an event happens.
                                                                                                                                                                                    
+
                                                                                                                                                                                  Returns TableauEventUnregisterFn
                                                                                                                                                                                  A helper function which can be called to remove this registration.
                                                                                                                                                                                  
+
                                                                                                                                                                                  The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
+When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
+the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                                                                                  
+
                                                                                                                                                                                  // Add an event listener for the selection changed event on this sheet.
                                                                                                                                                                                  // Assigning the event to a variable just to make the example fit on the page here.
                                                                                                                                                                                   const markSelection = tableau.TableauEventType.MarkSelectionChanged;
                                                                                                                                                                                    //
                                                                                                                                                                                   unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
                                                                                                                                                                                   // When the selection changes, reload the data
                                                                                                                                                                                       loadSelectedMarks(worksheetName);
                                                                                                                                                                                   });

                                                                                                                                                                                  // remove the event listener when done
                                                                                                                                                                                   unregisterEventHandlerFunction();
                                                                                                                                                                                  
+
                                                                                                                                                                                  
 
-// remove the event listener when done
- unregisterEventHandlerFunction();
-
                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              changeValueAsync

                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • changeValueAsync(newValue: string | number | boolean | Date): Promise<DataValue>
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • - -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Modifies this parameter and assigns it a new value. The new value must fall within - the domain restrictions defined by allowableValues. If the domain restriction is ParameterValueType.Range, - be sure to check the allowableValues before assigning a new value. If the new value is out of range, the - updated value will be set to either the minValue or the maxValue of the allowable range. If a step size is also specified - and the new value does not fall on the step intervals, the updated value will be set to the closest, lower step, - or closest, earlier date. If the domain restriction is type ParameterValueType.List, and there are aliases defined for the list, - the aliased value should be passed to the method.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Parameters

                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • -
                                                                                                                                                                                  newValue: string | number | boolean | Date
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  The new value to assign to this parameter. - Note: For changing Date parameters, UTC Date objects are expected.

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  • -
                                                                                                                                                                                -

                                                                                                                                                                                Returns Promise<DataValue>

                                                                                                                                                                                -

                                                                                                                                                                                The updated DataValue. The promise is rejected if newValue is invalid. However, if the domain restriction - is type AllowableValuesType.Range, and the newValue is out of the range bounds, the parameter gets set to the minValue - or the maxValue of the range (whichever is closer). If the range has a stepSize or dateStepPeriod, the parameter gets set - to the closest, lower step, or the closest, earlier date.

                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              removeEventListener

                                                                                                                                                                              - -
                                                                                                                                                                                -
                                                                                                                                                                              • - -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function - returned from the call to addEventListener to unregister the event listener. - For more information, see Events and Event Handling.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Parameters

                                                                                                                                                                                - -

                                                                                                                                                                                Returns boolean

                                                                                                                                                                                -

                                                                                                                                                                                Whether or not an event listener was removed.

                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -
                                                                                                                                                                              +

                                                                                                                                                                              • Modifies this parameter and assigns it a new value. The new value must fall within +the domain restrictions defined by allowableValues. If the domain restriction is ParameterValueType.Range, +be sure to check the allowableValues before assigning a new value. If the new value is out of range, the +updated value will be set to either the minValue or the maxValue of the allowable range. If a step size is also specified +and the new value does not fall on the step intervals, the updated value will be set to the closest, lower step, +or closest, earlier date. If the domain restriction is type ParameterValueType.List, and there are aliases defined for the list, +the aliased value should be passed to the method.

                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                • newValue: string | number | boolean | Date

                                                                                                                                                                                  The new value to assign to this parameter.

                                                                                                                                                                                  +
                                                                                                                                                                                  Note

                                                                                                                                                                                  For changing Date parameters, UTC Date objects are expected.

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Legend

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Module
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Object literal
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Variable
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Function
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Function with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Type alias
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Enumeration
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Enumeration member
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Interface
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Interface with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Class
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Class with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Inherited constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Protected property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Protected method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Protected accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Private property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Private method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Private accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Static property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Static method
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - - \ No newline at end of file +

                                                                                                                                                                                Returns Promise<DataValue>

                                                                                                                                                                                The updated DataValue. The promise is rejected if newValue is invalid. However, if the domain restriction +is type AllowableValuesType.Range, and the newValue is out of the range bounds, the parameter gets set to the minValue +or the maxValue of the range (whichever is closer). If the range has a stepSize or dateStepPeriod, the parameter gets set +to the closest, lower step, or the closest, earlier date.

                                                                                                                                                                                +

                                                                                                                                                                              • Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function +returned from the call to addEventListener to unregister the event listener. +For more information, see Events and Event Handling.

                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                Returns boolean

                                                                                                                                                                                Whether or not an event listener was removed.

                                                                                                                                                                                +

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Properties
                                                                                                                                                                              Methods
                                                                                                                                                                              diff --git a/website/static/api/interfaces/parameterchangedevent.html b/website/static/api/interfaces/parameterchangedevent.html index 8f25b5f7..6f70bf28 100644 --- a/website/static/api/interfaces/parameterchangedevent.html +++ b/website/static/api/interfaces/parameterchangedevent.html @@ -1,254 +1,30 @@ - - - - - - ParameterChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - Options -
                                                                                                                                                                              -
                                                                                                                                                                              - All -
                                                                                                                                                                                -
                                                                                                                                                                              • Public
                                                                                                                                                                                • -
                                                                                                                                                                              • Public/Protected
                                                                                                                                                                                • -
                                                                                                                                                                              • All
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - Menu -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              Interface ParameterChangedEvent

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              An event which is raised when the value of a parameter changes.

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Hierarchy

                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Index

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Properties

                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Methods

                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Properties

                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              type

                                                                                                                                                                              -
                                                                                                                                                                              type: TableauEventType
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              returns
                                                                                                                                                                              -

                                                                                                                                                                              The type of event which this class is representing.

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Methods

                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              getParameterAsync

                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • getParameterAsync(): Promise<Parameter>
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • - -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Returns Promise<Parameter>

                                                                                                                                                                                -

                                                                                                                                                                                The parameter that was changed.

                                                                                                                                                                                -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Legend

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Module
                                                                                                                                                                                • -
                                                                                                                                                                              • Object literal
                                                                                                                                                                                • -
                                                                                                                                                                              • Variable
                                                                                                                                                                                • -
                                                                                                                                                                              • Function
                                                                                                                                                                                • -
                                                                                                                                                                              • Function with type parameter
                                                                                                                                                                                • -
                                                                                                                                                                              • Index signature
                                                                                                                                                                                • -
                                                                                                                                                                              • Type alias
                                                                                                                                                                                • -
                                                                                                                                                                              • Type alias with type parameter
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Enumeration
                                                                                                                                                                                • -
                                                                                                                                                                              • Enumeration member
                                                                                                                                                                                • -
                                                                                                                                                                              • Property
                                                                                                                                                                                • -
                                                                                                                                                                              • Method
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Interface
                                                                                                                                                                                • -
                                                                                                                                                                              • Interface with type parameter
                                                                                                                                                                                • -
                                                                                                                                                                              • Constructor
                                                                                                                                                                                • -
                                                                                                                                                                              • Property
                                                                                                                                                                                • -
                                                                                                                                                                              • Method
                                                                                                                                                                                • -
                                                                                                                                                                              • Index signature
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Class
                                                                                                                                                                                • -
                                                                                                                                                                              • Class with type parameter
                                                                                                                                                                                • -
                                                                                                                                                                              • Constructor
                                                                                                                                                                                • -
                                                                                                                                                                              • Property
                                                                                                                                                                                • -
                                                                                                                                                                              • Method
                                                                                                                                                                                • -
                                                                                                                                                                              • Accessor
                                                                                                                                                                                • -
                                                                                                                                                                              • Index signature
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Inherited constructor
                                                                                                                                                                                • -
                                                                                                                                                                              • Inherited property
                                                                                                                                                                                • -
                                                                                                                                                                              • Inherited method
                                                                                                                                                                                • -
                                                                                                                                                                              • Inherited accessor
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Protected property
                                                                                                                                                                                • -
                                                                                                                                                                              • Protected method
                                                                                                                                                                                • -
                                                                                                                                                                              • Protected accessor
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Private property
                                                                                                                                                                                • -
                                                                                                                                                                              • Private method
                                                                                                                                                                                • -
                                                                                                                                                                              • Private accessor
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                                -
                                                                                                                                                                              • Static property
                                                                                                                                                                                • -
                                                                                                                                                                              • Static method
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - - \ No newline at end of file +ParameterChangedEvent | Tableau Extensions API
                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface ParameterChangedEvent

                                                                                                                                                                                An event which is raised when the value of a parameter changes.

                                                                                                                                                                                +
                                                                                                                                                                                interface ParameterChangedEvent {
                                                                                                                                                                                    type: TableauEventType;
                                                                                                                                                                                    getParameterAsync(): Promise<Parameter>;
                                                                                                                                                                                }

                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                type +

                                                                                                                                                                                Methods

                                                                                                                                                                                getParameterAsync +

                                                                                                                                                                                Properties

                                                                                                                                                                                type: TableauEventType

                                                                                                                                                                                The type of event which this class is representing.

                                                                                                                                                                                +

                                                                                                                                                                                Methods

                                                                                                                                                                                • Returns Promise<Parameter>

                                                                                                                                                                                  The parameter that was changed.

                                                                                                                                                                                  +

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility

                                                                                                                                                                                On This Page

                                                                                                                                                                                Properties
                                                                                                                                                                                Methods
                                                                                                                                                                                diff --git a/website/static/api/interfaces/parameterdomainrestriction.html b/website/static/api/interfaces/parameterdomainrestriction.html index fc31a161..03ff0787 100644 --- a/website/static/api/interfaces/parameterdomainrestriction.html +++ b/website/static/api/interfaces/parameterdomainrestriction.html @@ -1,333 +1,50 @@ - - - - - - ParameterDomainRestriction | Tableau Extensions - - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - Options -
                                                                                                                                                                                -
                                                                                                                                                                                - All -
                                                                                                                                                                                  -
                                                                                                                                                                                • Public
                                                                                                                                                                                  • -
                                                                                                                                                                                • Public/Protected
                                                                                                                                                                                  • -
                                                                                                                                                                                • All
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                - Menu -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Interface ParameterDomainRestriction

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Represents the allowable set of values which a parameter can be set to.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • - ParameterDomainRestriction -
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Index

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Properties

                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Properties

                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Optional allowableValues

                                                                                                                                                                                -
                                                                                                                                                                                allowableValues: Array<DataValue>
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                If ParameterValueType.List, the array will be the list of - values which the parameter is allowed to take.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Optional dateStepPeriod

                                                                                                                                                                                -
                                                                                                                                                                                dateStepPeriod: PeriodType
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                If ParameterValueType.Range, this defines the step date period - used in the Parameter UI control slider. Note that if you specify a new value for the parameter, - using the changeValueAsync() method, that does not align on the dateStepPeriod interval, the - value will be set to the closest, earlier date.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Optional maxValue

                                                                                                                                                                                -
                                                                                                                                                                                maxValue: DataValue
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                If ParameterValueType.Range, the value will be the upper - bound of allowable values for the parameter.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Optional minValue

                                                                                                                                                                                -
                                                                                                                                                                                minValue: DataValue
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                If ParameterValueType.Range, the value will be the lower - bound of allowable values for the parameter.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Optional stepSize

                                                                                                                                                                                -
                                                                                                                                                                                stepSize: undefined | number
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                If ParameterValueType.Range, the value will - define the step size used in the parameter UI control slider. - Note that if you specify a new value for the parameter, using the changeValueAsync() method, - that does not align on the stepSize interval, the value will be set to the closest, lower interval. - For example, if the stepSize was 5 and the steps were 1, 5, 10, if the new value specified - was 8, the value 5 would be used instead.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                type

                                                                                                                                                                                -
                                                                                                                                                                                type: ParameterValueType
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                returns
                                                                                                                                                                                -

                                                                                                                                                                                The type of restriction we have on the parameter's domain. This value - will effect what other properties are configured on this object.

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Legend

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Module
                                                                                                                                                                                  • -
                                                                                                                                                                                • Object literal
                                                                                                                                                                                  • -
                                                                                                                                                                                • Variable
                                                                                                                                                                                  • -
                                                                                                                                                                                • Function
                                                                                                                                                                                  • -
                                                                                                                                                                                • Function with type parameter
                                                                                                                                                                                  • -
                                                                                                                                                                                • Index signature
                                                                                                                                                                                  • -
                                                                                                                                                                                • Type alias
                                                                                                                                                                                  • -
                                                                                                                                                                                • Type alias with type parameter
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Enumeration
                                                                                                                                                                                  • -
                                                                                                                                                                                • Enumeration member
                                                                                                                                                                                  • -
                                                                                                                                                                                • Property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Method
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Interface
                                                                                                                                                                                  • -
                                                                                                                                                                                • Interface with type parameter
                                                                                                                                                                                  • -
                                                                                                                                                                                • Constructor
                                                                                                                                                                                  • -
                                                                                                                                                                                • Property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Method
                                                                                                                                                                                  • -
                                                                                                                                                                                • Index signature
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Class
                                                                                                                                                                                  • -
                                                                                                                                                                                • Class with type parameter
                                                                                                                                                                                  • -
                                                                                                                                                                                • Constructor
                                                                                                                                                                                  • -
                                                                                                                                                                                • Property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Method
                                                                                                                                                                                  • -
                                                                                                                                                                                • Accessor
                                                                                                                                                                                  • -
                                                                                                                                                                                • Index signature
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Inherited constructor
                                                                                                                                                                                  • -
                                                                                                                                                                                • Inherited property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Inherited method
                                                                                                                                                                                  • -
                                                                                                                                                                                • Inherited accessor
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Protected property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Protected method
                                                                                                                                                                                  • -
                                                                                                                                                                                • Protected accessor
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Private property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Private method
                                                                                                                                                                                  • -
                                                                                                                                                                                • Private accessor
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • Static property
                                                                                                                                                                                  • -
                                                                                                                                                                                • Static method
                                                                                                                                                                                  • -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - \ No newline at end of file +ParameterDomainRestriction | Tableau Extensions API
                                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Interface ParameterDomainRestriction

                                                                                                                                                                                  Represents the allowable set of values which a parameter can be set to.

                                                                                                                                                                                  +
                                                                                                                                                                                  interface ParameterDomainRestriction {
                                                                                                                                                                                      allowableValues?: DataValue[];
                                                                                                                                                                                      dateStepPeriod?: PeriodType;
                                                                                                                                                                                      maxValue?: DataValue;
                                                                                                                                                                                      minValue?: DataValue;
                                                                                                                                                                                      stepSize?: number;
                                                                                                                                                                                      type: ParameterValueType;
                                                                                                                                                                                  }
                                                                                                                                                                                  Index

                                                                                                                                                                                  Properties

                                                                                                                                                                                  allowableValues? +dateStepPeriod? +maxValue? +minValue? +stepSize? +type +

                                                                                                                                                                                  Properties

                                                                                                                                                                                  allowableValues?: DataValue[]

                                                                                                                                                                                  If ParameterValueType.List, the array will be the list of +values which the parameter is allowed to take.

                                                                                                                                                                                  +
                                                                                                                                                                                  dateStepPeriod?: PeriodType

                                                                                                                                                                                  If ParameterValueType.Range, this defines the step date period +used in the Parameter UI control slider. Note that if you specify a new value for the parameter, +using the changeValueAsync() method, that does not align on the dateStepPeriod interval, the +value will be set to the closest, earlier date.

                                                                                                                                                                                  +
                                                                                                                                                                                  maxValue?: DataValue

                                                                                                                                                                                  If ParameterValueType.Range, the value will be the upper +bound of allowable values for the parameter.

                                                                                                                                                                                  +
                                                                                                                                                                                  minValue?: DataValue

                                                                                                                                                                                  If ParameterValueType.Range, the value will be the lower +bound of allowable values for the parameter.

                                                                                                                                                                                  +
                                                                                                                                                                                  stepSize?: number

                                                                                                                                                                                  If ParameterValueType.Range, the value will +define the step size used in the parameter UI control slider. +Note that if you specify a new value for the parameter, using the changeValueAsync() method, +that does not align on the stepSize interval, the value will be set to the closest, lower interval. +For example, if the stepSize was 5 and the steps were 1, 5, 10, if the new value specified +was 8, the value 5 would be used instead.

                                                                                                                                                                                  +
                                                                                                                                                                                  type: ParameterValueType

                                                                                                                                                                                  The type of restriction we have on the parameter's domain. This value +will effect what other properties are configured on this object.

                                                                                                                                                                                  +

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Properties
                                                                                                                                                                                  diff --git a/website/static/api/interfaces/point.html b/website/static/api/interfaces/point.html index 5d820ffe..cd28e3ea 100644 --- a/website/static/api/interfaces/point.html +++ b/website/static/api/interfaces/point.html @@ -1,237 +1,30 @@ - - - - - - Point | Tableau Extensions - - - - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - Options -
                                                                                                                                                                                  -
                                                                                                                                                                                  - All -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Public
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Public/Protected
                                                                                                                                                                                    • -
                                                                                                                                                                                  • All
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - Menu -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  Interface Point

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Represents an x/y coordinate in pixels.

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • - Point -
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Index

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • x
                                                                                                                                                                                    • -
                                                                                                                                                                                  • y
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  x

                                                                                                                                                                                  -
                                                                                                                                                                                  x: number
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  returns
                                                                                                                                                                                  -

                                                                                                                                                                                  X coordinate of point.

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  y

                                                                                                                                                                                  -
                                                                                                                                                                                  y: number
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  returns
                                                                                                                                                                                  -

                                                                                                                                                                                  Y coordinate of point.

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Legend

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Module
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Object literal
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Variable
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Function
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Function with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Type alias
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Enumeration
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Enumeration member
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Interface
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Interface with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Class
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Class with type parameter
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Index signature
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Inherited constructor
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Inherited accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Protected property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Protected method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Protected accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Private property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Private method
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Private accessor
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • Static property
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Static method
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - - \ No newline at end of file +Point | Tableau Extensions API
                                                                                                                                                                                  Tableau Extensions API
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface Point

                                                                                                                                                                                    Represents an x/y coordinate in pixels.

                                                                                                                                                                                    +
                                                                                                                                                                                    interface Point {
                                                                                                                                                                                        x: number;
                                                                                                                                                                                        y: number;
                                                                                                                                                                                    }
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    x +y +

                                                                                                                                                                                    Properties

                                                                                                                                                                                    x: number

                                                                                                                                                                                    X coordinate of point.

                                                                                                                                                                                    +
                                                                                                                                                                                    y: number

                                                                                                                                                                                    Y coordinate of point.

                                                                                                                                                                                    +

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    Properties
                                                                                                                                                                                    diff --git a/website/static/api/interfaces/rangedomain.html b/website/static/api/interfaces/rangedomain.html index 7d5cf29d..fb60e17f 100644 --- a/website/static/api/interfaces/rangedomain.html +++ b/website/static/api/interfaces/rangedomain.html @@ -1,258 +1,32 @@ - - - - - - RangeDomain | Tableau Extensions - - - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - Options -
                                                                                                                                                                                    -
                                                                                                                                                                                    - All -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Public
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Public/Protected
                                                                                                                                                                                      • -
                                                                                                                                                                                    • All
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - Menu -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -

                                                                                                                                                                                    Interface RangeDomain

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    The domain of range filter

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • - RangeDomain -
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    Index

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    Properties

                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    Properties

                                                                                                                                                                                    -
                                                                                                                                                                                    - -

                                                                                                                                                                                    max

                                                                                                                                                                                    -
                                                                                                                                                                                    max: DataValue
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    returns
                                                                                                                                                                                    -

                                                                                                                                                                                    Maximum value as specified in the domain.

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -

                                                                                                                                                                                    min

                                                                                                                                                                                    -
                                                                                                                                                                                    min: DataValue
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    returns
                                                                                                                                                                                    -

                                                                                                                                                                                    Minimum value as specified in the domain.

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -

                                                                                                                                                                                    type

                                                                                                                                                                                    -
                                                                                                                                                                                    type: FilterDomainType
                                                                                                                                                                                    - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    returns
                                                                                                                                                                                    -

                                                                                                                                                                                    the domain type (relevant, all)

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -

                                                                                                                                                                                    Legend

                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Module
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Object literal
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Variable
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Function
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Index signature
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Type alias
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Method
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Interface
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Constructor
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Method
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Index signature
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Class
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Constructor
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Method
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Accessor
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Index signature
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Protected property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Protected method
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Private property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Private method
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                      -
                                                                                                                                                                                    • Static property
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Static method
                                                                                                                                                                                      • -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - \ No newline at end of file +RangeDomain | Tableau Extensions API
                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface RangeDomain

                                                                                                                                                                                      The domain of range filter

                                                                                                                                                                                      +
                                                                                                                                                                                      interface RangeDomain {
                                                                                                                                                                                          max: DataValue;
                                                                                                                                                                                          min: DataValue;
                                                                                                                                                                                          type: FilterDomainType;
                                                                                                                                                                                      }
                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      max +min +type +

                                                                                                                                                                                      Properties

                                                                                                                                                                                      max: DataValue

                                                                                                                                                                                      Maximum value as specified in the domain.

                                                                                                                                                                                      +
                                                                                                                                                                                      min: DataValue

                                                                                                                                                                                      Minimum value as specified in the domain.

                                                                                                                                                                                      +
                                                                                                                                                                                      type: FilterDomainType

                                                                                                                                                                                      the domain type (relevant, all)

                                                                                                                                                                                      +

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      diff --git a/website/static/api/interfaces/rangefilter.html b/website/static/api/interfaces/rangefilter.html index b5d307f6..26900d93 100644 --- a/website/static/api/interfaces/rangefilter.html +++ b/website/static/api/interfaces/rangefilter.html @@ -1,496 +1,56 @@ - - - - - - RangeFilter | Tableau Extensions - - - - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - Options -
                                                                                                                                                                                      -
                                                                                                                                                                                      - All -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Public
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Public/Protected
                                                                                                                                                                                        • -
                                                                                                                                                                                      • All
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - Menu -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      Interface RangeFilter

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      A Range Filter

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • - Filter -
                                                                                                                                                                                          -
                                                                                                                                                                                        • - RangeFilter -
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Index

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Properties

                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Methods

                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Properties

                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      fieldId

                                                                                                                                                                                      -
                                                                                                                                                                                      fieldId: string
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      The id of the field being filtered.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      fieldName

                                                                                                                                                                                      -
                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      The name of the field being filtered. Note that this is the caption - as shown in the UI, and not the actual database field name.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      filterType

                                                                                                                                                                                      -
                                                                                                                                                                                      filterType: FilterType
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      The type of the filter.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      includeNullValues

                                                                                                                                                                                      -
                                                                                                                                                                                      includeNullValues: boolean
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      True if null values are included in the filter, false otherwise.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      maxValue

                                                                                                                                                                                      -
                                                                                                                                                                                      maxValue: DataValue
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      Maximum value, inclusive, applied to the filter.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      minValue

                                                                                                                                                                                      -
                                                                                                                                                                                      minValue: DataValue
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      Minimum value, inclusive, applied to the filter.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      worksheetName

                                                                                                                                                                                      -
                                                                                                                                                                                      worksheetName: string
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      returns
                                                                                                                                                                                      -

                                                                                                                                                                                      The parent worksheet.

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Methods

                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      getAppliedWorksheetsAsync

                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • getAppliedWorksheetsAsync(): Promise<Array<string>>
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        since
                                                                                                                                                                                        -

                                                                                                                                                                                        1.9.0 and Tableau 2022.2

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns Promise<Array<string>>

                                                                                                                                                                                        -

                                                                                                                                                                                        the list of worksheet names that have the filter applied.

                                                                                                                                                                                        -
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      getDomainAsync

                                                                                                                                                                                      - -
                                                                                                                                                                                        -
                                                                                                                                                                                      • - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • -
                                                                                                                                                                                          Optional domainType: FilterDomainType
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          the domain type, defaults to relevant

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          • -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns Promise<RangeDomain>

                                                                                                                                                                                        -

                                                                                                                                                                                        a promise containing the domain for the range filter

                                                                                                                                                                                        -
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      getFieldAsync

                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • getFieldAsync(): Promise<Field>
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        since
                                                                                                                                                                                        -

                                                                                                                                                                                        1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns Promise<Field>

                                                                                                                                                                                        -

                                                                                                                                                                                        a promise containing the field for the filter.

                                                                                                                                                                                        -
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      setAppliedWorksheetsAsync

                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        since
                                                                                                                                                                                        -

                                                                                                                                                                                        1.9.0 and Tableau 2022.2

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • -
                                                                                                                                                                                          applyToWorksheets: Array<string>
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          list of worksheets to apply the filter on

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          • -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns Promise<Array<string>>

                                                                                                                                                                                        -

                                                                                                                                                                                        the list of worksheet names that have the filter applied

                                                                                                                                                                                        -
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Legend

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Module
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Object literal
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Variable
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Function
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Function with type parameter
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Index signature
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Type alias
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Type alias with type parameter
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Enumeration
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Enumeration member
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Method
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Interface
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Interface with type parameter
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Constructor
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Method
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Index signature
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Class
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Class with type parameter
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Constructor
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Method
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Accessor
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Index signature
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Inherited constructor
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Inherited property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Inherited method
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Inherited accessor
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Protected property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Protected method
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Protected accessor
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Private property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Private method
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Private accessor
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                        -
                                                                                                                                                                                      • Static property
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Static method
                                                                                                                                                                                        • -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - - - - \ No newline at end of file +RangeFilter | Tableau Extensions API
                                                                                                                                                                                      Tableau Extensions API
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface RangeFilter

                                                                                                                                                                                        A Range Filter

                                                                                                                                                                                        +
                                                                                                                                                                                        interface RangeFilter {
                                                                                                                                                                                            fieldId: string;
                                                                                                                                                                                            fieldName: string;
                                                                                                                                                                                            filterType: FilterType;
                                                                                                                                                                                            includeNullValues: boolean;
                                                                                                                                                                                            maxValue: DataValue;
                                                                                                                                                                                            minValue: DataValue;
                                                                                                                                                                                            worksheetName: string;
                                                                                                                                                                                            getAppliedWorksheetsAsync(): Promise<string[]>;
                                                                                                                                                                                            getDomainAsync(domainType?: FilterDomainType): Promise<RangeDomain>;
                                                                                                                                                                                            getFieldAsync(): Promise<Field>;
                                                                                                                                                                                            setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
                                                                                                                                                                                        }

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        fieldId +fieldName +filterType +includeNullValues +maxValue +minValue +worksheetName +

                                                                                                                                                                                        Methods

                                                                                                                                                                                        getAppliedWorksheetsAsync +getDomainAsync +getFieldAsync +setAppliedWorksheetsAsync +

                                                                                                                                                                                        Properties

                                                                                                                                                                                        fieldId: string

                                                                                                                                                                                        The id of the field being filtered.

                                                                                                                                                                                        +
                                                                                                                                                                                        fieldName: string

                                                                                                                                                                                        The name of the field being filtered. Note that this is the caption +as shown in the UI, and not the actual database field name.

                                                                                                                                                                                        +
                                                                                                                                                                                        filterType: FilterType

                                                                                                                                                                                        The type of the filter.

                                                                                                                                                                                        +
                                                                                                                                                                                        includeNullValues: boolean

                                                                                                                                                                                        True if null values are included in the filter, false otherwise.

                                                                                                                                                                                        +
                                                                                                                                                                                        maxValue: DataValue

                                                                                                                                                                                        Maximum value, inclusive, applied to the filter.

                                                                                                                                                                                        +
                                                                                                                                                                                        minValue: DataValue

                                                                                                                                                                                        Minimum value, inclusive, applied to the filter.

                                                                                                                                                                                        +
                                                                                                                                                                                        worksheetName: string

                                                                                                                                                                                        The parent worksheet.

                                                                                                                                                                                        +

                                                                                                                                                                                        Methods

                                                                                                                                                                                        • Returns Promise<string[]>

                                                                                                                                                                                          the list of worksheet names that have the filter applied.

                                                                                                                                                                                          +

                                                                                                                                                                                          1.9.0 and Tableau 2022.2

                                                                                                                                                                                          +

                                                                                                                                                                                        • Parameters

                                                                                                                                                                                          Returns Promise<RangeDomain>

                                                                                                                                                                                          a promise containing the domain for the range filter

                                                                                                                                                                                          +

                                                                                                                                                                                        • Returns Promise<Field>

                                                                                                                                                                                          a promise containing the field for the filter.

                                                                                                                                                                                          +

                                                                                                                                                                                          1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                                                          +

                                                                                                                                                                                        • Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                                                          +

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • applyToWorksheets: string[]

                                                                                                                                                                                            list of worksheets to apply the filter on

                                                                                                                                                                                            +

                                                                                                                                                                                          Returns Promise<string[]>

                                                                                                                                                                                          the list of worksheet names that have the filter applied

                                                                                                                                                                                          +

                                                                                                                                                                                          1.9.0 and Tableau 2022.2

                                                                                                                                                                                          +

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        Properties
                                                                                                                                                                                        Methods
                                                                                                                                                                                        diff --git a/website/static/api/interfaces/rangefilteroptions.html b/website/static/api/interfaces/rangefilteroptions.html index 7fa65393..da9d6d23 100644 --- a/website/static/api/interfaces/rangefilteroptions.html +++ b/website/static/api/interfaces/rangefilteroptions.html @@ -1,237 +1,29 @@ - - - - - - RangeFilterOptions | Tableau Extensions - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - Options -
                                                                                                                                                                                        -
                                                                                                                                                                                        - All -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Public
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Public/Protected
                                                                                                                                                                                          • -
                                                                                                                                                                                        • All
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - Menu -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -

                                                                                                                                                                                        Interface RangeFilterOptions

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Options for Range Filter

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • - RangeFilterOptions -
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Index

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Properties

                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Properties

                                                                                                                                                                                        -
                                                                                                                                                                                        - -

                                                                                                                                                                                        Optional max

                                                                                                                                                                                        -
                                                                                                                                                                                        max: number | Date
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -

                                                                                                                                                                                        Optional min

                                                                                                                                                                                        -
                                                                                                                                                                                        min: number | Date
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - -

                                                                                                                                                                                        Optional nullOption

                                                                                                                                                                                        -
                                                                                                                                                                                        nullOption: FilterNullOption
                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -

                                                                                                                                                                                        Legend

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Module
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Object literal
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Variable
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Function
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Function with type parameter
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Index signature
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Type alias
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Type alias with type parameter
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Enumeration
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Enumeration member
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Method
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Interface
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Interface with type parameter
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Constructor
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Method
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Index signature
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Class
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Class with type parameter
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Constructor
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Method
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Accessor
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Index signature
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Inherited constructor
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Inherited property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Inherited method
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Inherited accessor
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Protected property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Protected method
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Protected accessor
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Private property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Private method
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Private accessor
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • Static property
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Static method
                                                                                                                                                                                          • -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - \ No newline at end of file +RangeFilterOptions | Tableau Extensions API
                                                                                                                                                                                        Tableau Extensions API
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface RangeFilterOptions

                                                                                                                                                                                          Options for Range Filter

                                                                                                                                                                                          +
                                                                                                                                                                                          interface RangeFilterOptions {
                                                                                                                                                                                              max?: number | Date;
                                                                                                                                                                                              min?: number | Date;
                                                                                                                                                                                              nullOption?: FilterNullOption;
                                                                                                                                                                                          }
                                                                                                                                                                                          Index

                                                                                                                                                                                          Properties

                                                                                                                                                                                          max? +min? +nullOption? +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          max?: number | Date
                                                                                                                                                                                          min?: number | Date
                                                                                                                                                                                          nullOption?: FilterNullOption

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Properties
                                                                                                                                                                                          diff --git a/website/static/api/interfaces/rangevalue.html b/website/static/api/interfaces/rangevalue.html index d6828598..0c166766 100644 --- a/website/static/api/interfaces/rangevalue.html +++ b/website/static/api/interfaces/rangevalue.html @@ -1,255 +1,35 @@ - - - - - - RangeValue | Tableau Extensions - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - Options -
                                                                                                                                                                                          -
                                                                                                                                                                                          - All -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Public
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Public/Protected
                                                                                                                                                                                            • -
                                                                                                                                                                                          • All
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - Menu -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -

                                                                                                                                                                                          Interface RangeValue

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          RangeValue interface to provide selection value for range based selections. - The associated field should be a quantitative field. - For Date Values, UTC Date objects are expected. (i.e., var min = new Date(Date.UTC(1999, 0, 1))). - While date string inputs work, UTC date inputs are officially supported going forward for RangeValue.

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • - RangeValue -
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Index

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Properties

                                                                                                                                                                                          -
                                                                                                                                                                                          - -

                                                                                                                                                                                          max

                                                                                                                                                                                          -
                                                                                                                                                                                          max: number | Date
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          max range value for the range based selection

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -

                                                                                                                                                                                          min

                                                                                                                                                                                          -
                                                                                                                                                                                          min: number | Date
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          min range value for the range based selection

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -

                                                                                                                                                                                          Optional nullOption

                                                                                                                                                                                          -
                                                                                                                                                                                          nullOption: FilterNullOption
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Including nulloptions parameter.

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -

                                                                                                                                                                                          Legend

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Module
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Object literal
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Variable
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Function
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Index signature
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Type alias
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Enumeration
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Enumeration member
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Method
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Interface
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Constructor
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Method
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Index signature
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Class
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Constructor
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Method
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Accessor
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Index signature
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Inherited property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Inherited method
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Protected property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Protected method
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Protected accessor
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Private property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Private method
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Private accessor
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                            -
                                                                                                                                                                                          • Static property
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Static method
                                                                                                                                                                                            • -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - \ No newline at end of file +RangeValue | Tableau Extensions API
                                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface RangeValue

                                                                                                                                                                                            RangeValue interface to provide selection value for range based selections. +The associated field should be a quantitative field. +For Date Values, UTC Date objects are expected. (i.e., var min = new Date(Date.UTC(1999, 0, 1))). +While date string inputs work, UTC date inputs are officially supported going forward for RangeValue.

                                                                                                                                                                                            +
                                                                                                                                                                                            interface RangeValue {
                                                                                                                                                                                                max: number | Date;
                                                                                                                                                                                                min: number | Date;
                                                                                                                                                                                                nullOption?: FilterNullOption;
                                                                                                                                                                                            }
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            max +min +nullOption? +

                                                                                                                                                                                            Properties

                                                                                                                                                                                            max: number | Date

                                                                                                                                                                                            max range value for the range based selection

                                                                                                                                                                                            +
                                                                                                                                                                                            min: number | Date

                                                                                                                                                                                            min range value for the range based selection

                                                                                                                                                                                            +
                                                                                                                                                                                            nullOption?: FilterNullOption

                                                                                                                                                                                            Including nulloptions parameter.

                                                                                                                                                                                            +

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            diff --git a/website/static/api/interfaces/relativedatefilter.html b/website/static/api/interfaces/relativedatefilter.html index e062429e..a21810c4 100644 --- a/website/static/api/interfaces/relativedatefilter.html +++ b/website/static/api/interfaces/relativedatefilter.html @@ -1,477 +1,55 @@ - - - - - - RelativeDateFilter | Tableau Extensions - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - Options -
                                                                                                                                                                                            -
                                                                                                                                                                                            - All -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Public
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Public/Protected
                                                                                                                                                                                              • -
                                                                                                                                                                                            • All
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - Menu -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            Interface RelativeDateFilter

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - Filter -
                                                                                                                                                                                                -
                                                                                                                                                                                              • - RelativeDateFilter -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Index

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Properties

                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Methods

                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Properties

                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            anchorDate

                                                                                                                                                                                            -
                                                                                                                                                                                            anchorDate: DataValue
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            the anchor date of the filter

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            fieldId

                                                                                                                                                                                            -
                                                                                                                                                                                            fieldId: string
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The id of the field being filtered.

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            fieldName

                                                                                                                                                                                            -
                                                                                                                                                                                            fieldName: string
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The name of the field being filtered. Note that this is the caption - as shown in the UI, and not the actual database field name.

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            filterType

                                                                                                                                                                                            -
                                                                                                                                                                                            filterType: FilterType
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The type of the filter.

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            periodType

                                                                                                                                                                                            -
                                                                                                                                                                                            periodType: PeriodType
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The date period of the filter.

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            rangeN

                                                                                                                                                                                            -
                                                                                                                                                                                            rangeN: number
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            rangeType

                                                                                                                                                                                            -
                                                                                                                                                                                            rangeType: DateRangeType
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The range of the date filter (years, months, etc.).

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            worksheetName

                                                                                                                                                                                            -
                                                                                                                                                                                            worksheetName: string
                                                                                                                                                                                            - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            returns
                                                                                                                                                                                            -

                                                                                                                                                                                            The parent worksheet.

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Methods

                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            getAppliedWorksheetsAsync

                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • getAppliedWorksheetsAsync(): Promise<Array<string>>
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              since
                                                                                                                                                                                              -

                                                                                                                                                                                              1.9.0 and Tableau 2022.2

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Returns Promise<Array<string>>

                                                                                                                                                                                              -

                                                                                                                                                                                              the list of worksheet names that have the filter applied.

                                                                                                                                                                                              -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            getFieldAsync

                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • getFieldAsync(): Promise<Field>
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              since
                                                                                                                                                                                              -

                                                                                                                                                                                              1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Returns Promise<Field>

                                                                                                                                                                                              -

                                                                                                                                                                                              a promise containing the field for the filter.

                                                                                                                                                                                              -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - -

                                                                                                                                                                                            setAppliedWorksheetsAsync

                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • setAppliedWorksheetsAsync(applyToWorksheets: Array<string>): Promise<Array<string>>
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Applies the filter to the specified list of worksheets. - If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              since
                                                                                                                                                                                              -

                                                                                                                                                                                              1.9.0 and Tableau 2022.2

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • -
                                                                                                                                                                                                applyToWorksheets: Array<string>
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                list of worksheets to apply the filter on

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -

                                                                                                                                                                                              Returns Promise<Array<string>>

                                                                                                                                                                                              -

                                                                                                                                                                                              the list of worksheet names that have the filter applied

                                                                                                                                                                                              -
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -

                                                                                                                                                                                            Legend

                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Module
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Object literal
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Variable
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Function
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Function with type parameter
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Index signature
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Type alias
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Type alias with type parameter
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Enumeration
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Enumeration member
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Method
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Interface
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Interface with type parameter
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Constructor
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Method
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Index signature
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Class
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Class with type parameter
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Constructor
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Method
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Accessor
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Index signature
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Inherited constructor
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Inherited property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Inherited method
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Inherited accessor
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Protected property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Protected method
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Protected accessor
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Private property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Private method
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Private accessor
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                              -
                                                                                                                                                                                            • Static property
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Static method
                                                                                                                                                                                              • -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - - \ No newline at end of file +RelativeDateFilter | Tableau Extensions API
                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface RelativeDateFilter

                                                                                                                                                                                              An abstract base class for all of the filter types.

                                                                                                                                                                                              +
                                                                                                                                                                                              interface RelativeDateFilter {
                                                                                                                                                                                                  anchorDate: DataValue;
                                                                                                                                                                                                  fieldId: string;
                                                                                                                                                                                                  fieldName: string;
                                                                                                                                                                                                  filterType: FilterType;
                                                                                                                                                                                                  periodType: PeriodType;
                                                                                                                                                                                                  rangeN: number;
                                                                                                                                                                                                  rangeType: DateRangeType;
                                                                                                                                                                                                  worksheetName: string;
                                                                                                                                                                                                  getAppliedWorksheetsAsync(): Promise<string[]>;
                                                                                                                                                                                                  getFieldAsync(): Promise<Field>;
                                                                                                                                                                                                  setAppliedWorksheetsAsync(applyToWorksheets: string[]): Promise<string[]>;
                                                                                                                                                                                              }

                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              anchorDate +fieldId +fieldName +filterType +periodType +rangeN +rangeType +worksheetName +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              getAppliedWorksheetsAsync +getFieldAsync +setAppliedWorksheetsAsync +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              anchorDate: DataValue

                                                                                                                                                                                              the anchor date of the filter

                                                                                                                                                                                              +
                                                                                                                                                                                              fieldId: string

                                                                                                                                                                                              The id of the field being filtered.

                                                                                                                                                                                              +
                                                                                                                                                                                              fieldName: string

                                                                                                                                                                                              The name of the field being filtered. Note that this is the caption +as shown in the UI, and not the actual database field name.

                                                                                                                                                                                              +
                                                                                                                                                                                              filterType: FilterType

                                                                                                                                                                                              The type of the filter.

                                                                                                                                                                                              +
                                                                                                                                                                                              periodType: PeriodType

                                                                                                                                                                                              The date period of the filter.

                                                                                                                                                                                              +
                                                                                                                                                                                              rangeN: number

                                                                                                                                                                                              When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).

                                                                                                                                                                                              +
                                                                                                                                                                                              rangeType: DateRangeType

                                                                                                                                                                                              The range of the date filter (years, months, etc.).

                                                                                                                                                                                              +
                                                                                                                                                                                              worksheetName: string

                                                                                                                                                                                              The parent worksheet.

                                                                                                                                                                                              +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              • Returns Promise<string[]>

                                                                                                                                                                                                the list of worksheet names that have the filter applied.

                                                                                                                                                                                                +

                                                                                                                                                                                                1.9.0 and Tableau 2022.2

                                                                                                                                                                                                +

                                                                                                                                                                                              • Returns Promise<Field>

                                                                                                                                                                                                a promise containing the field for the filter.

                                                                                                                                                                                                +

                                                                                                                                                                                                1.5.0 Fixed to properly return the field. Also requires Tableau 2019.2+.

                                                                                                                                                                                                +

                                                                                                                                                                                              • Applies the filter to the specified list of worksheets. +If the worksheet(s) do not exist or do not contain the field in their data sources, an exception is thrown.

                                                                                                                                                                                                +

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • applyToWorksheets: string[]

                                                                                                                                                                                                  list of worksheets to apply the filter on

                                                                                                                                                                                                  +

                                                                                                                                                                                                Returns Promise<string[]>

                                                                                                                                                                                                the list of worksheet names that have the filter applied

                                                                                                                                                                                                +

                                                                                                                                                                                                1.9.0 and Tableau 2022.2

                                                                                                                                                                                                +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Properties
                                                                                                                                                                                              Methods
                                                                                                                                                                                              diff --git a/website/static/api/interfaces/relativedatefilteroptions.html b/website/static/api/interfaces/relativedatefilteroptions.html index 7187f78f..58cd2c31 100644 --- a/website/static/api/interfaces/relativedatefilteroptions.html +++ b/website/static/api/interfaces/relativedatefilteroptions.html @@ -1,284 +1,35 @@ - - - - - - RelativeDateFilterOptions | Tableau Extensions - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - Options -
                                                                                                                                                                                              -
                                                                                                                                                                                              - All -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Public
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Public/Protected
                                                                                                                                                                                                • -
                                                                                                                                                                                              • All
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - Menu -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              Interface RelativeDateFilterOptions

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Options for Relative Date Filter

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              since
                                                                                                                                                                                              -

                                                                                                                                                                                              version 1.9.0 and Tableau 2022.2

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • - RelativeDateFilterOptions -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Index

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              Optional anchorDate

                                                                                                                                                                                              -
                                                                                                                                                                                              anchorDate: Date
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              returns
                                                                                                                                                                                              -

                                                                                                                                                                                              the anchor date of the filter

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              periodType

                                                                                                                                                                                              -
                                                                                                                                                                                              periodType: PeriodType
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              returns
                                                                                                                                                                                              -

                                                                                                                                                                                              The date period of the filter (years, months, etc.).

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              Optional rangeN

                                                                                                                                                                                              -
                                                                                                                                                                                              rangeN: undefined | number
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              returns
                                                                                                                                                                                              -

                                                                                                                                                                                              When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              rangeType

                                                                                                                                                                                              -
                                                                                                                                                                                              rangeType: DateRangeType
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              returns
                                                                                                                                                                                              -

                                                                                                                                                                                              The range of the date filter.

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Legend

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Module
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Object literal
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Variable
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Function
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Function with type parameter
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Type alias
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Type alias with type parameter
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Enumeration
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Enumeration member
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Method
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Interface
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Interface with type parameter
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Method
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Class
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Class with type parameter
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Method
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Accessor
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Inherited constructor
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Inherited property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Inherited method
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Inherited accessor
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Protected property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Protected method
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Protected accessor
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Private property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Private method
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Private accessor
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Static property
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Static method
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - \ No newline at end of file +RelativeDateFilterOptions | Tableau Extensions API
                                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface RelativeDateFilterOptions

                                                                                                                                                                                                Options for Relative Date Filter

                                                                                                                                                                                                +

                                                                                                                                                                                                version 1.9.0 and Tableau 2022.2

                                                                                                                                                                                                +
                                                                                                                                                                                                interface RelativeDateFilterOptions {
                                                                                                                                                                                                    anchorDate?: Date;
                                                                                                                                                                                                    periodType: PeriodType;
                                                                                                                                                                                                    rangeN?: number;
                                                                                                                                                                                                    rangeType: DateRangeType;
                                                                                                                                                                                                }
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                anchorDate? +periodType +rangeN? +rangeType +

                                                                                                                                                                                                Properties

                                                                                                                                                                                                anchorDate?: Date

                                                                                                                                                                                                the anchor date of the filter

                                                                                                                                                                                                +
                                                                                                                                                                                                periodType: PeriodType

                                                                                                                                                                                                The date period of the filter (years, months, etc.).

                                                                                                                                                                                                +
                                                                                                                                                                                                rangeN?: number

                                                                                                                                                                                                When getRange returns LASTN or NEXTN, this is the N value (how many years, months, etc.).

                                                                                                                                                                                                +
                                                                                                                                                                                                rangeType: DateRangeType

                                                                                                                                                                                                The range of the date filter.

                                                                                                                                                                                                +

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                diff --git a/website/static/api/interfaces/selectioncriteria.html b/website/static/api/interfaces/selectioncriteria.html index 0df8f7cd..3c9bd5b8 100644 --- a/website/static/api/interfaces/selectioncriteria.html +++ b/website/static/api/interfaces/selectioncriteria.html @@ -1,236 +1,33 @@ - - - - - - SelectionCriteria | Tableau Extensions - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - Options -
                                                                                                                                                                                                -
                                                                                                                                                                                                - All -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Public
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Public/Protected
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • All
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - Menu -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -

                                                                                                                                                                                                Interface SelectionCriteria

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                SelectionCriteria interface is used to specify to the fieldName to values for Hierarchical, Categorical and Range based selections.

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • - SelectionCriteria -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Index

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Properties

                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Properties

                                                                                                                                                                                                -
                                                                                                                                                                                                - -

                                                                                                                                                                                                fieldName

                                                                                                                                                                                                -
                                                                                                                                                                                                fieldName: string
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Fieldname of the mark that is intended to be selected. - Hierarchical fields follow the convention of "[{parentField}].[{selectingField}]"

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - -

                                                                                                                                                                                                value

                                                                                                                                                                                                -
                                                                                                                                                                                                value: CategoricalValue | RangeValue
                                                                                                                                                                                                - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Value that is intended to be selected. This can be specified as the list of values or a single value. - Range-based selections need to provide the value in the format of RangeValue interface. - To select a single quantitative value, use the RangeValue interface where both max and min are the value you want to select.

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -

                                                                                                                                                                                                Legend

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Module
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Object literal
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Variable
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Function
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Function with type parameter
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Type alias
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Type alias with type parameter
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Enumeration
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Enumeration member
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Interface
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Interface with type parameter
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Class
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Class with type parameter
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Accessor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Inherited constructor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Inherited property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Inherited method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Inherited accessor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Protected property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Protected method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Protected accessor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Private property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Private method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Private accessor
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Static property
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • Static method
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - \ No newline at end of file +SelectionCriteria | Tableau Extensions API
                                                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Interface SelectionCriteria

                                                                                                                                                                                                  SelectionCriteria interface is used to specify to the fieldName to values for Hierarchical, Categorical and Range based selections.

                                                                                                                                                                                                  +
                                                                                                                                                                                                  interface SelectionCriteria {
                                                                                                                                                                                                      fieldName: string;
                                                                                                                                                                                                      value: CategoricalValue | RangeValue;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  fieldName +value +

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  fieldName: string

                                                                                                                                                                                                  Fieldname of the mark that is intended to be selected. +Hierarchical fields follow the convention of "[{parentField}].[{selectingField}]"

                                                                                                                                                                                                  +
                                                                                                                                                                                                  value: CategoricalValue | RangeValue

                                                                                                                                                                                                  Value that is intended to be selected. This can be specified as the list of values or a single value. +Range-based selections need to provide the value in the format of RangeValue interface. +To select a single quantitative value, use the RangeValue interface where both max and min are the value you want to select.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Properties
                                                                                                                                                                                                  diff --git a/website/static/api/interfaces/settings.html b/website/static/api/interfaces/settings.html index a99fe6a0..d23f9e1b 100644 --- a/website/static/api/interfaces/settings.html +++ b/website/static/api/interfaces/settings.html @@ -1,540 +1,99 @@ - - - - - - Settings | Tableau Extensions - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - Options -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - All -
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • Public
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Public/Protected
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • All
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - Menu -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  Interface Settings

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  The settings namespace is used to get and set settings - values. You can use the settings to configure your extension. - The setting values are be persisted in a workbook.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Index

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Methods

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  isModified

                                                                                                                                                                                                  -
                                                                                                                                                                                                  isModified: boolean
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Indicates whether or not the settings have been - modified since the last call to saveAsync.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  returns
                                                                                                                                                                                                  -

                                                                                                                                                                                                  True if settings have been modified, false otherwise.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Methods

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  addEventListener

                                                                                                                                                                                                  - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Adds a new event listener to the object. If this object does not support the specified eventType, - the method throws an exception. - The following table shows the event types supported by objects.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    objecteventType
                                                                                                                                                                                                    WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                                                    ParameterParameterChanged
                                                                                                                                                                                                    SettingsSettingsChanged
                                                                                                                                                                                                    DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                      eventType: TableauEventType
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The type of event to register for. The type of event is a TableauEventType enumeration.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                      handler: TableauEventHandlerFn
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The function which will be called when an event happens.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Returns TableauEventUnregisterFn

                                                                                                                                                                                                    -

                                                                                                                                                                                                    A helper function which can be called to remove this registration.

                                                                                                                                                                                                    -

                                                                                                                                                                                                    The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged). - When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers - the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.

                                                                                                                                                                                                    - 
                                                                                                                                                                                                    // Add an event listener for the selection changed event on this sheet.
-// Assigning the event to a variable just to make the example fit on the page here.
-const markSelection = tableau.TableauEventType.MarkSelectionChanged;
-//
-unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
-// When the selection changes, reload the data
-loadSelectedMarks(worksheetName);
-});
+Settings | Tableau Extensions API
                                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      Interface Settings
                                                                                                                                                                                                      The settings namespace is used to get and set settings
+values. You can use the settings to configure your extension.
+The setting values are be persisted in a workbook.
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      interface Settings {
                                                                                                                                                                                                          isModified: boolean;
                                                                                                                                                                                                          addEventListener(
                                                                                                                                                                                                              eventType: TableauEventType,
                                                                                                                                                                                                              handler: TableauEventHandlerFn,
                                                                                                                                                                                                          ): TableauEventUnregisterFn;
                                                                                                                                                                                                          erase(key: string): void;
                                                                                                                                                                                                          get(key: string): undefined | string;
                                                                                                                                                                                                          getAll(): { [key: string]: string };
                                                                                                                                                                                                          removeEventListener(
                                                                                                                                                                                                              eventType: TableauEventType,
                                                                                                                                                                                                              handler: TableauEventHandlerFn,
                                                                                                                                                                                                          ): boolean;
                                                                                                                                                                                                          saveAsync(): Promise<{ [key: string]: string }>;
                                                                                                                                                                                                          set(key: string, value: string): void;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      Hierarchy (View Summary)
                                                                                                                                                                                                      Index
                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      isModified
+
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      addEventListener
+erase
+get
+getAll
+removeEventListener
+saveAsync
+set
+
                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      isModified: boolean
                                                                                                                                                                                                      Indicates whether or not the settings have been
+modified since the last call to saveAsync.
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      True if settings have been modified, false otherwise.
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      • Adds a new event listener to the object. If this object does not support the specified eventType,
+the method throws an exception.
+The following table shows the event types supported by objects.
                                                                                                                                                                                                        
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                        objecteventType
                                                                                                                                                                                                        WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                                                        ParameterParameterChanged
                                                                                                                                                                                                        SettingsSettingsChanged
                                                                                                                                                                                                        DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        • eventType: TableauEventType
                                                                                                                                                                                                          The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                        • handler: TableauEventHandlerFn
                                                                                                                                                                                                          The function which will be called when an event happens.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                        Returns TableauEventUnregisterFn
                                                                                                                                                                                                        A helper function which can be called to remove this registration.
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
+When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
+the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        // Add an event listener for the selection changed event on this sheet.
                                                                                                                                                                                                        // Assigning the event to a variable just to make the example fit on the page here.
                                                                                                                                                                                                         const markSelection = tableau.TableauEventType.MarkSelectionChanged;
                                                                                                                                                                                                          //
                                                                                                                                                                                                         unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
                                                                                                                                                                                                         // When the selection changes, reload the data
                                                                                                                                                                                                             loadSelectedMarks(worksheetName);
                                                                                                                                                                                                         });

                                                                                                                                                                                                        // remove the event listener when done
                                                                                                                                                                                                         unregisterEventHandlerFunction();
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        
 
-// remove the event listener when done
- unregisterEventHandlerFunction();
-
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    erase

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • erase(key: string): void
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Erases a settings key / value pair. If key isn't found, nothing happens.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                        key: string
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        The key of the pair to erase.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    get

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • get(key: string): string | undefined
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Gets a settings value or undefined if the value does not exist.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                        key: string
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        The key to retrieve.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns string | undefined

                                                                                                                                                                                                      -

                                                                                                                                                                                                      The value or undefined if it does not exist.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    getAll

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • getAll(): {}
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns a copy of all the saved settings keys and values. - Modifying this value will have no effect on the class.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns {}

                                                                                                                                                                                                      -

                                                                                                                                                                                                      All the saved settings keys and values in a dictionary.

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                        [key: string]: string
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    removeEventListener

                                                                                                                                                                                                    - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function - returned from the call to addEventListener to unregister the event listener. - For more information, see Events and Event Handling.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      - -

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Whether or not an event listener was removed.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    saveAsync

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • saveAsync(): Promise<{}>
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Attempts to persist any currently modified settings key-value pairs. The saveAsync() method - should only be called in authoring mode.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns Promise<{}>

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Promise containing the newly saved settings values.

                                                                                                                                                                                                      - 
                                                                                                                                                                                                      tableau.extensions.settings.saveAsync().then(result => {
-   console.log('Settings saved.');
-   // ... process results
-}).catch((error) => {
-  // ...
-  // ... code for error handling
-});
-
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    set

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • set(key: string, value: string): void
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Adds or updates a settings key / value pair.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                        key: string
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        The key to save.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                        value: string
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        The value to save.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Legend

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Module
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Object literal
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Variable
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Function
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Type alias
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Interface
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Class
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Protected property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Protected method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Private property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Private method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Static property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Static method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - \ No newline at end of file +

                                                                                                                                                                                                    • Adds or updates a settings key / value pair.

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • key: string

                                                                                                                                                                                                        The key to save.

                                                                                                                                                                                                        +
                                                                                                                                                                                                      • value: string

                                                                                                                                                                                                        The value to save.

                                                                                                                                                                                                        +

                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    Methods
                                                                                                                                                                                                    diff --git a/website/static/api/interfaces/settingschangedevent.html b/website/static/api/interfaces/settingschangedevent.html index 4af2df03..e64adb07 100644 --- a/website/static/api/interfaces/settingschangedevent.html +++ b/website/static/api/interfaces/settingschangedevent.html @@ -1,252 +1,31 @@ - - - - - - SettingsChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - Options -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - All -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Public
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Public/Protected
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • All
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - Menu -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    Interface SettingsChangedEvent

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    An event which is raised when the settings of an extension are updated. - Should be listened for directly from the tableau.extensions.settings object.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Index

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    newSettings

                                                                                                                                                                                                    -
                                                                                                                                                                                                    newSettings: {}
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    returns
                                                                                                                                                                                                    -

                                                                                                                                                                                                    the new settings that were recently saved.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                      [key: string]: string
                                                                                                                                                                                                      -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    type

                                                                                                                                                                                                    -
                                                                                                                                                                                                    type: TableauEventType
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    returns
                                                                                                                                                                                                    -

                                                                                                                                                                                                    The type of event which this class is representing.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Legend

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Module
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Object literal
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Variable
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Function
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Type alias
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Interface
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Class
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Protected property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Protected method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Private property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Private method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Static property
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Static method
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - \ No newline at end of file +SettingsChangedEvent | Tableau Extensions API
                                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface SettingsChangedEvent

                                                                                                                                                                                                      An event which is raised when the settings of an extension are updated. +Should be listened for directly from the tableau.extensions.settings object.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface SettingsChangedEvent {
                                                                                                                                                                                                          newSettings: { [key: string]: string };
                                                                                                                                                                                                          type: TableauEventType;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      newSettings +type +

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      newSettings: { [key: string]: string }

                                                                                                                                                                                                      the new settings that were recently saved.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      type: TableauEventType

                                                                                                                                                                                                      The type of event which this class is representing.

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      diff --git a/website/static/api/interfaces/sheet.html b/website/static/api/interfaces/sheet.html index 028ec250..1bdde300 100644 --- a/website/static/api/interfaces/sheet.html +++ b/website/static/api/interfaces/sheet.html @@ -1,456 +1,84 @@ - - - - - - Sheet | Tableau Extensions - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - Options -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - All -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Public
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • Public/Protected
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • All
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - Menu -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      Interface Sheet

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Index

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Methods

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      name

                                                                                                                                                                                                      -
                                                                                                                                                                                                      name: string
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      returns
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The name of the sheet.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      sheetType

                                                                                                                                                                                                      -
                                                                                                                                                                                                      sheetType: SheetType
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      returns
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The type of the sheet.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      size

                                                                                                                                                                                                      -
                                                                                                                                                                                                      size: Size
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      returns
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Size of the sheet.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Methods

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      addEventListener

                                                                                                                                                                                                      - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Adds a new event listener to the object. If this object does not support the specified eventType, - the method throws an exception. - The following table shows the event types supported by objects.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                        objecteventType
                                                                                                                                                                                                        WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                                                        ParameterParameterChanged
                                                                                                                                                                                                        SettingsSettingsChanged
                                                                                                                                                                                                        DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                          eventType: TableauEventType
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The type of event to register for. The type of event is a TableauEventType enumeration.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                          handler: TableauEventHandlerFn
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The function which will be called when an event happens.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Returns TableauEventUnregisterFn

                                                                                                                                                                                                        -

                                                                                                                                                                                                        A helper function which can be called to remove this registration.

                                                                                                                                                                                                        -

                                                                                                                                                                                                        The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged). - When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers - the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.

                                                                                                                                                                                                        - 
                                                                                                                                                                                                        // Add an event listener for the selection changed event on this sheet.
-// Assigning the event to a variable just to make the example fit on the page here.
-const markSelection = tableau.TableauEventType.MarkSelectionChanged;
-//
-unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
-// When the selection changes, reload the data
-loadSelectedMarks(worksheetName);
-});
+Sheet | Tableau Extensions API
                                                                                                                                                                                                        Tableau Extensions API
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          Interface Sheet
                                                                                                                                                                                                          Interface for handling registering and unregistering event listeners. Different objects will implement
+this interface to manage their event handling.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          interface Sheet {
                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                              sheetType: SheetType;
                                                                                                                                                                                                              size: Size;
                                                                                                                                                                                                              addEventListener(
                                                                                                                                                                                                                  eventType: TableauEventType,
                                                                                                                                                                                                                  handler: TableauEventHandlerFn,
                                                                                                                                                                                                              ): TableauEventUnregisterFn;
                                                                                                                                                                                                              findParameterAsync(parameterName: string): Promise<undefined | Parameter>;
                                                                                                                                                                                                              getParametersAsync(): Promise<Parameter[]>;
                                                                                                                                                                                                              removeEventListener(
                                                                                                                                                                                                                  eventType: TableauEventType,
                                                                                                                                                                                                                  handler: TableauEventHandlerFn,
                                                                                                                                                                                                              ): boolean;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Hierarchy (View Summary)
                                                                                                                                                                                                          Index
                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          name
+sheetType
+size
+
                                                                                                                                                                                                          Methods
                                                                                                                                                                                                          addEventListener
+findParameterAsync
+getParametersAsync
+removeEventListener
+
                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          name: string
                                                                                                                                                                                                          The name of the sheet.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          sheetType: SheetType
                                                                                                                                                                                                          The type of the sheet.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          size: Size
                                                                                                                                                                                                          Size of the sheet.
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          Methods
                                                                                                                                                                                                          • Adds a new event listener to the object. If this object does not support the specified eventType,
+the method throws an exception.
+The following table shows the event types supported by objects.
                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                            objecteventType
                                                                                                                                                                                                            WorksheetFilterChanged , MarkSelectionChanged, SummaryDataChanged, WorksheetFormattingChanged
                                                                                                                                                                                                            ParameterParameterChanged
                                                                                                                                                                                                            SettingsSettingsChanged
                                                                                                                                                                                                            DashboardDashboardLayoutChanged, WorkbookFormattingChanged
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            • eventType: TableauEventType
                                                                                                                                                                                                              The type of event to register for. The type of event is a TableauEventType enumeration.
                                                                                                                                                                                                              
+
                                                                                                                                                                                                            • handler: TableauEventHandlerFn
                                                                                                                                                                                                              The function which will be called when an event happens.
                                                                                                                                                                                                              
+
                                                                                                                                                                                                            Returns TableauEventUnregisterFn
                                                                                                                                                                                                            A helper function which can be called to remove this registration.
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            The following example sets up a listener in a worksheet for a mark selection event (MarkSelectionChanged).
+When the event occurs, the data is reloaded. The addEventListener method returns a function that un-registers
+the event handler. Call that function, in this case, unregisterEventHandlerFunction() to remove the registration.
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            // Add an event listener for the selection changed event on this sheet.
                                                                                                                                                                                                            // Assigning the event to a variable just to make the example fit on the page here.
                                                                                                                                                                                                             const markSelection = tableau.TableauEventType.MarkSelectionChanged;
                                                                                                                                                                                                              //
                                                                                                                                                                                                             unregisterEventHandlerFunction = worksheet.addEventListener(markSelection, function (selectionEvent) {
                                                                                                                                                                                                             // When the selection changes, reload the data
                                                                                                                                                                                                                 loadSelectedMarks(worksheetName);
                                                                                                                                                                                                             });

                                                                                                                                                                                                            // remove the event listener when done
                                                                                                                                                                                                             unregisterEventHandlerFunction();
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            
 
-// remove the event listener when done
- unregisterEventHandlerFunction();
-
                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        findParameterAsync

                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • findParameterAsync(parameterName: string): Promise<Parameter | undefined>
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Searches for a parameter with the given name.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                            parameterName: string
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            The name of the parameter to find.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns Promise<Parameter | undefined>

                                                                                                                                                                                                          -

                                                                                                                                                                                                          The parameter with the given name, or undefined if it does not exist.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        getParametersAsync

                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • getParametersAsync(): Promise<Array<Parameter>>
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Returns Promise<Array<Parameter>>

                                                                                                                                                                                                          -

                                                                                                                                                                                                          A collection of all the Tableau parameters that are used in this workbook.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        removeEventListener

                                                                                                                                                                                                        - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function - returned from the call to addEventListener to unregister the event listener. - For more information, see Events and Event Handling.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          - -

                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                          -

                                                                                                                                                                                                          Whether or not an event listener was removed.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Legend

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Module
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Object literal
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Variable
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Function
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Function with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Type alias
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Type alias with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Enumeration
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Enumeration member
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Interface
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Interface with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Class
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Class with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Inherited constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Protected property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Protected method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Protected accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Private property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Private method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Private accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Static property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Static method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - - - - \ No newline at end of file +

                                                                                                                                                                                                        • Searches for a parameter with the given name.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          • parameterName: string

                                                                                                                                                                                                            The name of the parameter to find.

                                                                                                                                                                                                            +

                                                                                                                                                                                                          Returns Promise<undefined | Parameter>

                                                                                                                                                                                                          The parameter with the given name, or undefined if it does not exist.

                                                                                                                                                                                                          +

                                                                                                                                                                                                        • Returns Promise<Parameter[]>

                                                                                                                                                                                                          A collection of all the Tableau parameters that are used in this workbook.

                                                                                                                                                                                                          +

                                                                                                                                                                                                        • Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. +The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function +returned from the call to addEventListener to unregister the event listener. +For more information, see Events and Event Handling.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                          Whether or not an event listener was removed.

                                                                                                                                                                                                          +

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                        Properties
                                                                                                                                                                                                        Methods
                                                                                                                                                                                                        diff --git a/website/static/api/interfaces/size.html b/website/static/api/interfaces/size.html index 89bac840..5a1e2b7f 100644 --- a/website/static/api/interfaces/size.html +++ b/website/static/api/interfaces/size.html @@ -1,237 +1,30 @@ - - - - - - Size | Tableau Extensions - - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - Options -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - All -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Public
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Public/Protected
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • All
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - Menu -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        Interface Size

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Represents a width and height in pixels.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - Size -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Index

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        height

                                                                                                                                                                                                        -
                                                                                                                                                                                                        height: number
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        returns
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Height of the size object.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - -

                                                                                                                                                                                                        width

                                                                                                                                                                                                        -
                                                                                                                                                                                                        width: number
                                                                                                                                                                                                        - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        returns
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Width of the size object.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Legend

                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Module
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Object literal
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Variable
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Function
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Function with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Type alias
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Type alias with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Enumeration
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Enumeration member
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Interface
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Interface with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Class
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Class with type parameter
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Index signature
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Inherited constructor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Inherited accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Protected property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Protected method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Protected accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Private property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Private method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Private accessor
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Static property
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Static method
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - - - - - \ No newline at end of file +Size | Tableau Extensions API
                                                                                                                                                                                                        Tableau Extensions API
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface Size

                                                                                                                                                                                                          Represents a width and height in pixels.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface Size {
                                                                                                                                                                                                              height: number;
                                                                                                                                                                                                              width: number;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          height +width +

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          height: number

                                                                                                                                                                                                          Height of the size object.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          width: number

                                                                                                                                                                                                          Width of the size object.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Properties
                                                                                                                                                                                                          diff --git a/website/static/api/interfaces/summarydatachangedevent.html b/website/static/api/interfaces/summarydatachangedevent.html index 0519c63d..2bcdeded 100644 --- a/website/static/api/interfaces/summarydatachangedevent.html +++ b/website/static/api/interfaces/summarydatachangedevent.html @@ -1,271 +1,33 @@ - - - - - - SummaryDataChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - Options -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - All -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Public
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Public/Protected
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • All
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - Menu -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          Interface SummaryDataChangedEvent

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          An event which is raised when summary data is changed for a worksheet or when a worksheet's data source is refreshed

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          since
                                                                                                                                                                                                          -

                                                                                                                                                                                                          1.11.0 and Tableau 2024.1

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Index

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          sheet

                                                                                                                                                                                                          -
                                                                                                                                                                                                          sheet: Sheet
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          returns
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The sheet which was the source of this event.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          type

                                                                                                                                                                                                          -
                                                                                                                                                                                                          type: TableauEventType
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          returns
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The type of event which this class is representing.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          worksheet

                                                                                                                                                                                                          -
                                                                                                                                                                                                          worksheet: Worksheet
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          returns
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The worksheet which was the source of this event.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Legend

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Module
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Object literal
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Variable
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Function
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Type alias
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Enumeration
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Enumeration member
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Interface
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Class
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Accessor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Inherited property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Inherited method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Protected property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Protected method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Protected accessor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Private property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Private method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Private accessor
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Static property
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Static method
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - - - - \ No newline at end of file +SummaryDataChangedEvent | Tableau Extensions API
                                                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface SummaryDataChangedEvent

                                                                                                                                                                                                            An event which is raised when summary data is changed for a worksheet or when a worksheet's data source is refreshed

                                                                                                                                                                                                            +

                                                                                                                                                                                                            1.11.0 and Tableau 2024.1

                                                                                                                                                                                                            +
                                                                                                                                                                                                            interface SummaryDataChangedEvent {
                                                                                                                                                                                                                sheet: Sheet;
                                                                                                                                                                                                                type: TableauEventType;
                                                                                                                                                                                                                worksheet: Worksheet;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            sheet +type +worksheet +

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            sheet: Sheet

                                                                                                                                                                                                            The sheet which was the source of this event.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            type: TableauEventType

                                                                                                                                                                                                            The type of event which this class is representing.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            worksheet: Worksheet

                                                                                                                                                                                                            The worksheet which was the source of this event.

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            diff --git a/website/static/api/interfaces/tableauerror.html b/website/static/api/interfaces/tableauerror.html index e9b65ec7..e033287f 100644 --- a/website/static/api/interfaces/tableauerror.html +++ b/website/static/api/interfaces/tableauerror.html @@ -1,280 +1,31 @@ - - - - - - TableauError | Tableau Extensions - - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - Options -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - All -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Public
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Public/Protected
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • All
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - Menu -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            Interface TableauError

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Custom error class that extends the default JavaScript Error object.

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • - Error -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • - TableauError -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            Error

                                                                                                                                                                                                            -
                                                                                                                                                                                                            Error: ErrorConstructor
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            errorCode

                                                                                                                                                                                                            -
                                                                                                                                                                                                            errorCode: ErrorCodes
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            returns
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Tableau specific ErrorCode

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            message

                                                                                                                                                                                                            -
                                                                                                                                                                                                            message: string
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            name

                                                                                                                                                                                                            -
                                                                                                                                                                                                            name: string
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            Optional stack

                                                                                                                                                                                                            -
                                                                                                                                                                                                            stack: undefined | string
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Legend

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Module
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Object literal
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Variable
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Function
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Function with type parameter
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Type alias
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Type alias with type parameter
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Enumeration
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Enumeration member
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Interface
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Interface with type parameter
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Constructor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Class
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Class with type parameter
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Constructor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Accessor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Inherited constructor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Inherited property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Inherited method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Inherited accessor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Protected property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Protected method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Protected accessor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Private property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Private method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Private accessor
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • Static property
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            • Static method
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - - - - \ No newline at end of file +TableauError | Tableau Extensions API
                                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface TableauError

                                                                                                                                                                                                              Custom error class that extends the default JavaScript Error object.

                                                                                                                                                                                                              +
                                                                                                                                                                                                              interface TableauError {
                                                                                                                                                                                                                  errorCode: ErrorCodes;
                                                                                                                                                                                                                  message: string;
                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                  stack?: string;
                                                                                                                                                                                                              }

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              • Error
                                                                                                                                                                                                                • TableauError
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              errorCode +message +name +stack? +

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              errorCode: ErrorCodes

                                                                                                                                                                                                              Tableau specific ErrorCode

                                                                                                                                                                                                              +
                                                                                                                                                                                                              message: string
                                                                                                                                                                                                              name: string
                                                                                                                                                                                                              stack?: string

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              diff --git a/website/static/api/interfaces/tableauevent.html b/website/static/api/interfaces/tableauevent.html index 0fc8b8fd..99a83898 100644 --- a/website/static/api/interfaces/tableauevent.html +++ b/website/static/api/interfaces/tableauevent.html @@ -1,237 +1,29 @@ - - - - - - TableauEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - Options -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - All -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Public
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Public/Protected
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • All
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - Menu -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Interface TableauEvent

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              An event object represents a notification that some sort of state has changed. - This is the base event interface. All events will inherit this type.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Index

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              type

                                                                                                                                                                                                              -
                                                                                                                                                                                                              type: TableauEventType
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              returns
                                                                                                                                                                                                              -

                                                                                                                                                                                                              The type of event which this class is representing.

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Legend

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Module
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Object literal
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Variable
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Function
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Function with type parameter
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Type alias
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Type alias with type parameter
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Enumeration
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Enumeration member
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Interface
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Interface with type parameter
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Class
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Class with type parameter
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Accessor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Inherited constructor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Inherited property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Inherited method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Inherited accessor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Protected property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Protected method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Protected accessor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Private property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Private method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Private accessor
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • Static property
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • Static method
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - - - - \ No newline at end of file +TableauEvent | Tableau Extensions API
                                                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface TableauEvent

                                                                                                                                                                                                                An event object represents a notification that some sort of state has changed. +This is the base event interface. All events will inherit this type.

                                                                                                                                                                                                                +
                                                                                                                                                                                                                interface TableauEvent {
                                                                                                                                                                                                                    type: TableauEventType;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                type +

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                type: TableauEventType

                                                                                                                                                                                                                The type of event which this class is representing.

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/website/static/api/interfaces/tableausheetevent.html b/website/static/api/interfaces/tableausheetevent.html index ab1b74fe..a724f2ae 100644 --- a/website/static/api/interfaces/tableausheetevent.html +++ b/website/static/api/interfaces/tableausheetevent.html @@ -1,248 +1,30 @@ - - - - - - TableauSheetEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - Options -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - All -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Public
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Public/Protected
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • All
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - Menu -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -

                                                                                                                                                                                                                Interface TableauSheetEvent

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                An event which is related to a particular Sheet (worksheet, dashboard, story) in the workbook.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Index

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -

                                                                                                                                                                                                                sheet

                                                                                                                                                                                                                -
                                                                                                                                                                                                                sheet: Sheet
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                returns
                                                                                                                                                                                                                -

                                                                                                                                                                                                                The sheet which was the source of this event.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -

                                                                                                                                                                                                                type

                                                                                                                                                                                                                -
                                                                                                                                                                                                                type: TableauEventType
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                returns
                                                                                                                                                                                                                -

                                                                                                                                                                                                                The type of event which this class is representing.

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Legend

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Module
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Object literal
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Variable
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Function
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Function with type parameter
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Type alias
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Type alias with type parameter
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Enumeration
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Enumeration member
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Interface
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Interface with type parameter
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Class
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Class with type parameter
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Accessor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Inherited constructor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Inherited property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Inherited method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Inherited accessor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Protected property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Protected method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Protected accessor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Private property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Private method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Private accessor
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Static property
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Static method
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - - - - \ No newline at end of file +TableauSheetEvent | Tableau Extensions API
                                                                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface TableauSheetEvent

                                                                                                                                                                                                                  An event which is related to a particular Sheet (worksheet, dashboard, story) in the workbook.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface TableauSheetEvent {
                                                                                                                                                                                                                      sheet: Sheet;
                                                                                                                                                                                                                      type: TableauEventType;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  sheet +type +

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  sheet: Sheet

                                                                                                                                                                                                                  The sheet which was the source of this event.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  type: TableauEventType

                                                                                                                                                                                                                  The type of event which this class is representing.

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  diff --git a/website/static/api/interfaces/tableauworksheetevent.html b/website/static/api/interfaces/tableauworksheetevent.html index 690fd092..b03739ef 100644 --- a/website/static/api/interfaces/tableauworksheetevent.html +++ b/website/static/api/interfaces/tableauworksheetevent.html @@ -1,279 +1,32 @@ - - - - - - TableauWorksheetEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - Options -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - All -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Public
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Public/Protected
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • All
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - Menu -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  Interface TableauWorksheetEvent

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  An event which is related to a particular Worksheet in the workbook.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  sheet

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  sheet: Sheet
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  The sheet which was the source of this event.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  type

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  type: TableauEventType
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  The type of event which this class is representing.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  worksheet

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  worksheet: Worksheet
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  The worksheet which was the source of this event.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Legend

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Module
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Object literal
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Variable
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Function
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Function with type parameter
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Type alias
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Enumeration
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Enumeration member
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Interface
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Interface with type parameter
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Constructor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Class
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Class with type parameter
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Constructor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Accessor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Inherited constructor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Inherited property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Inherited method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Inherited accessor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Protected property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Protected method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Protected accessor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Private property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Private method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Private accessor
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Static property
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Static method
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - - - - \ No newline at end of file +TableauWorksheetEvent | Tableau Extensions API
                                                                                                                                                                                                                  Tableau Extensions API
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface TableauWorksheetEvent

                                                                                                                                                                                                                    An event which is related to a particular Worksheet in the workbook.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    interface TableauWorksheetEvent {
                                                                                                                                                                                                                        sheet: Sheet;
                                                                                                                                                                                                                        type: TableauEventType;
                                                                                                                                                                                                                        worksheet: Worksheet;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    sheet +type +worksheet +

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    sheet: Sheet

                                                                                                                                                                                                                    The sheet which was the source of this event.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    type: TableauEventType

                                                                                                                                                                                                                    The type of event which this class is representing.

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    worksheet: Worksheet

                                                                                                                                                                                                                    The worksheet which was the source of this event.

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/website/static/api/interfaces/tablesummary.html b/website/static/api/interfaces/tablesummary.html index 4018c957..105e22e8 100644 --- a/website/static/api/interfaces/tablesummary.html +++ b/website/static/api/interfaces/tablesummary.html @@ -1,279 +1,34 @@ - - - - - - TableSummary | Tableau Extensions - - - - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - Options -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - All -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Public
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Public/Protected
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • All
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - Menu -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    Interface TableSummary

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Represents a table of data in a data source.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • - TableSummary -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    connectionId

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    connectionId: string
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    the ID of the connection that this table belongs to.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    customSQL

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    customSQL: string | undefined
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    the custom SQL used to create this table if it was created with Custom SQL, undefined otherwise.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    id

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    id: string
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Unique string representing this table.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    name

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    name: string
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    The name of the table (i.e. the caption).

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Legend

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Module
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Object literal
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Variable
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Function
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Type alias
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Interface
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Class
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Accessor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Protected property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Protected method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Private property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Private method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Static property
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Static method
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - - - - \ No newline at end of file +TableSummary | Tableau Extensions API
                                                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface TableSummary

                                                                                                                                                                                                                      Represents a table of data in a data source.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      interface TableSummary {
                                                                                                                                                                                                                          connectionId: string;
                                                                                                                                                                                                                          customSQL: undefined | string;
                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      connectionId +customSQL +id +name +

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      connectionId: string

                                                                                                                                                                                                                      the ID of the connection that this table belongs to.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      customSQL: undefined | string

                                                                                                                                                                                                                      the custom SQL used to create this table if it was created with Custom SQL, undefined otherwise.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      id: string

                                                                                                                                                                                                                      Unique string representing this table.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      name: string

                                                                                                                                                                                                                      The name of the table (i.e. the caption).

                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      diff --git a/website/static/api/interfaces/tooltipcontext.html b/website/static/api/interfaces/tooltipcontext.html index e1bd343e..47a9e041 100644 --- a/website/static/api/interfaces/tooltipcontext.html +++ b/website/static/api/interfaces/tooltipcontext.html @@ -1,219 +1,29 @@ - - - - - - TooltipContext | Tableau Extensions - - - - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - Options -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - All -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Public
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Public/Protected
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • All
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - Menu -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                      Interface TooltipContext

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Provides the necessary information for how to display a Tableau tooltip.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      since
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • - TooltipContext -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                      tooltipAnchorPoint

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      tooltipAnchorPoint: Point
                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Indicates where the tooltip should be displayed relative to the top left of the visualization.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Legend

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Module
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Object literal
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Variable
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Function
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Function with type parameter
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Index signature
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Type alias
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Type alias with type parameter
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Enumeration
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Enumeration member
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Interface
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Interface with type parameter
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Constructor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Index signature
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Class
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Class with type parameter
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Constructor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Accessor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Index signature
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Inherited constructor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Inherited property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Inherited method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Inherited accessor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Protected property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Protected method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Protected accessor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Private property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Private method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Private accessor
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Static property
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Static method
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - - - - - \ No newline at end of file +TooltipContext | Tableau Extensions API
                                                                                                                                                                                                                      Tableau Extensions API
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface TooltipContext

                                                                                                                                                                                                                        Provides the necessary information for how to display a Tableau tooltip.

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        interface TooltipContext {
                                                                                                                                                                                                                            tooltipAnchorPoint: Point;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        tooltipAnchorPoint +

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        tooltipAnchorPoint: Point

                                                                                                                                                                                                                        Indicates where the tooltip should be displayed relative to the top left of the visualization.

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                        diff --git a/website/static/api/interfaces/ui.html b/website/static/api/interfaces/ui.html index 96778cf4..2ea2b027 100644 --- a/website/static/api/interfaces/ui.html +++ b/website/static/api/interfaces/ui.html @@ -1,450 +1,88 @@ - - - - - - UI | Tableau Extensions - - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - Options -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - All -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • Public
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • Public/Protected
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • All
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - Menu -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        Interface UI

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        The UI namespace contains methods that allow an extension to display a popup - dialog window. A modal dialog can be useful in authentication or configuration scenarios, - or when extra situational UI space is needed. Only one dialog can be displayed at a time per extension. - Inside the popup dialog window, another extension can be loaded and run. This dialog extension will have full access - to the functions provided by the Extensions API. One difference between the extension running in the popup dialog window - and an extension running in the dashboard is that the popup dialog window must call - the initializeDialogAsync() method instead of initializeAsync() to initialize the extension.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Note If you want to use a popup dialog window on Tableau Server, you need to let users know that their browser must be - configured to allow popups.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - UI -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        closeDialog

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • closeDialog(payload?: undefined | string, dialogUrl?: undefined | string): void
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Closes the extension's dialog. Can be called from the popup dialog or from the extension itself.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            Optional payload: undefined | string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The payload is optional, and if specified, it is made available to parent extension when - this popup dialog closes. If the extension running in the popup dialog window does not return - a payload, you must still provide an empty string " " as a return value.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            Optional dialogUrl: undefined | string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Specifies the url of the dialog to close. - If the method is called from a dialog, and the dialogUrl is not specified, this will close the current dialog. - If the method is called from an extension, and the dialogUrl is not specified, this will close all open dialogs.

                                                                                                                                                                                                                            - 
                                                                                                                                                                                                                               tableau.extensions.ui.closeDialog('myPayload string');
-

                                                                                                                                                                                                                            The following example shows a call to the closeDialog method when the dialog extension does not return a payload.

                                                                                                                                                                                                                            - 
                                                                                                                                                                                                                               // specify an empty string if no payload is returned
-   tableau.extensions.ui.closeDialog('');
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        displayDialogAsync

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • displayDialogAsync(url: string, payload?: undefined | string, dialogOptions?: DialogOptions): Promise<string>
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          since
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          1.3.0 A relative path may be used beginning with Tableau 2019.3 and version 1.3.0 of the Extensions API library. - The relative path must resolve to the directory, or a child directory, of the extension. - Root-relative paths are not allowed. For example, ./config.html or config.html are allowed, - but not the root-relative path /config.html. - Note If your extension is meant for use in versions of Tableau prior to 2019.3, - you should use an absolute url.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            url: string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The url of the 'dialog extension' to navigate to in the dialog. The url must - belong to the same domain as the parent extension.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            Optional payload: undefined | string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The payload is optional, and is used to provide data to the popup dialog window - at startup. The payload will be returned to the dialog extension as the return - value of the call to the tableau.extensions.ui.initializeDialogAsync function. - If no payload is provided, you must indicate this with an empty string " ".

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            Optional dialogOptions: DialogOptions
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Specifies the options for the popup dialog window. - The dialogOptions has properties for width and height (in pixels) and a property for the dialog's style. - The dialog style can be a window, a modal dialog, or a modeless dialog. If style is not specified, window will be used. - You pass these properties to the displayDialogAsync function, as follows: - {width: number, height: number, dialogStyle: DialogStyle}

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Returns Promise<string>

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          A promise that resolves when the dialog has been closed. It will contain a - payload as a string provided by the dialog extension. The promise is rejected if - the user manually closes the dialog window (for example, by clicking the 'X' in window). - It is good practice to handle this error condition with a catch block, as in the following example.

                                                                                                                                                                                                                          - 
                                                                                                                                                                                                                            tableau.extensions.ui.displayDialogAsync(popupUrl, defaultPayload, { width: 500, height: 500 }).then((closePayload) => {
-    //
-    // The promise is resolved when the dialog has been closed as expected, meaning that
-    // the popup extension has called tableau.extensions.ui.closeDialog() method.
-    // The close payload (closePayload) is returned from the popup extension
-    // via the closeDialog() method.
-    //
-   }).catch((error) => {
-    // One expected error condition is when the popup is closed by the user (meaning the user
-    // clicks the 'X' in the top right of the dialog). This can be checked for like so:
-      switch(error.errorCode) {
-        case tableau.ErrorCodes.DialogClosedByUser:
-          console.log("Dialog was closed by user");
-          break;
-        default:
-      console.error(error.message);
-      }
-    });
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        sendDialogMessageAsync

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • sendDialogMessageAsync(message: string, targetDialogUrl?: undefined | string): any
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          experimental
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Sends a message from the dialog to the host extension or vice versa. - For dialogs sending messages to extensions, we must listen for the DialogMessageEvent in the extension in order to receive the message. - For extensions sending messages to dialog, we must listen for the DialogMessageEvent in the dialog code in order to receive the message. - For two way communication, listen for the DialogMessageEvent in both the dialog and extension code.

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            message: string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            A message to send.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                            Optional targetDialogUrl: undefined | string
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The url of the dialog to send the message to. If not provided, the message will be sent to the parent extension.

                                                                                                                                                                                                                            - 
                                                                                                                                                                                                                            
-  // Sending a message from the dialog to the extension:
+UI | Tableau Extensions API
                                                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                              Interface UI
                                                                                                                                                                                                                              The UI namespace contains methods that allow an extension to display a popup
+dialog window. A modal dialog can be useful in authentication or configuration scenarios,
+or when extra situational UI space is needed. Only one dialog can be displayed at a time per extension.
+Inside the popup dialog window, another extension can be loaded and run. This dialog extension will have full access
+to the functions provided by the Extensions API. One difference between the extension running in the popup dialog window
+and an extension running in the dashboard is that the popup dialog window must call
+the initializeDialogAsync() method instead of initializeAsync() to initialize the extension.
                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                              Note If you want to use a popup dialog window on Tableau Server, you need to let users know that their browser must be
+configured to allow popups.
                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                              interface UI {
                                                                                                                                                                                                                                  closeDialog(payload?: string, dialogUrl?: string): void;
                                                                                                                                                                                                                                  displayDialogAsync(
                                                                                                                                                                                                                                      url: string,
                                                                                                                                                                                                                                      payload?: string,
                                                                                                                                                                                                                                      dialogOptions?: DialogOptions,
                                                                                                                                                                                                                                  ): Promise<string>;
                                                                                                                                                                                                                                  sendDialogMessageAsync(message: string, targetDialogUrl?: string): any;
                                                                                                                                                                                                                                  sendDialogMessageToParentAsync(message: string): any;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              closeDialog
+displayDialogAsync
+sendDialogMessageAsync
+sendDialogMessageToParentAsync
+
                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              • Closes the extension's dialog. Can be called from the popup dialog or from the extension itself.
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                • Optionalpayload: string
                                                                                                                                                                                                                                  The payload is optional, and if specified, it is made available to parent extension when
+this popup dialog closes. If the extension running in the popup dialog window does not return
+a payload, you must still provide an empty string " " as a return value.
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                • OptionaldialogUrl: string
                                                                                                                                                                                                                                  Specifies the url of the dialog to close.
+If the method is called from a dialog, and the dialogUrl is not specified, this will close the current dialog.
+If the method is called from an extension, and the dialogUrl is not specified, this will close all open dialogs.
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                     tableau.extensions.ui.closeDialog('myPayload string');
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                  
 
-  // extension code (listening for messages originating from the dialog)
-  tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
-    console.log('Message received from dialog: ' + e.message);
-  })
-  tableau.extensions.ui.displayDialogAsync(popupUrl);
-  ...
+
                                                                                                                                                                                                                                  The following example shows a call to the closeDialog method when the dialog extension does not return a payload.
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                     // specify an empty string if no payload is returned
                                                                                                                                                                                                                                     tableau.extensions.ui.closeDialog('');
+
                                                                                                                                                                                                                                  
 
-                                                                                                                                                                                                                                    // dialog code (sending message to extension)
-  await tableau.extensions.initializeDialogAsync();
-  await tableau.extensions.ui.sendDialogMessageAsync('Hello from dialog!');
+
                                                                                                                                                                                                                                Returns void
                                                                                                                                                                                                                              • Parameters
                                                                                                                                                                                                                                • url: string
                                                                                                                                                                                                                                  The url of the 'dialog extension' to navigate to in the dialog. The url must
+belong to the same domain as the parent extension.
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                • Optionalpayload: string
                                                                                                                                                                                                                                  The payload is optional, and is used to provide data to the popup dialog window
+at startup. The payload will be returned to the dialog extension as the return
+value of the call to the tableau.extensions.ui.initializeDialogAsync function.
+If no payload is provided, you must indicate this with an empty string " ".
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                • OptionaldialogOptions: DialogOptions
                                                                                                                                                                                                                                  Specifies the options for the popup dialog window.
+The dialogOptions has properties for width and height (in pixels) and a property for the dialog's style.
+The dialog style can be a window, a modal dialog, or a modeless dialog. If style is not specified, window will be used.
+You pass these properties to the displayDialogAsync function, as follows:
+{width: number, height: number, dialogStyle: DialogStyle}
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                Returns Promise<string>
                                                                                                                                                                                                                                A promise that resolves when the dialog has been closed. It will contain a
+payload as a string provided by the dialog extension. The promise is rejected if
+the user manually closes the dialog window (for example, by clicking the 'X' in window).
+It is good practice to handle this error condition with a catch block, as in the following example.
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                 tableau.extensions.ui.displayDialogAsync(popupUrl, defaultPayload, { width: 500, height: 500 }).then((closePayload) => {
                                                                                                                                                                                                                                   //
                                                                                                                                                                                                                                   // The promise is resolved when the dialog has been closed as expected, meaning that
                                                                                                                                                                                                                                   // the popup extension has called tableau.extensions.ui.closeDialog() method.
                                                                                                                                                                                                                                   // The close payload (closePayload) is returned from the popup extension
                                                                                                                                                                                                                                   // via the closeDialog() method.
                                                                                                                                                                                                                                   //
                                                                                                                                                                                                                                  }).catch((error) => {
                                                                                                                                                                                                                                   // One expected error condition is when the popup is closed by the user (meaning the user
                                                                                                                                                                                                                                   // clicks the 'X' in the top right of the dialog). This can be checked for like so:
                                                                                                                                                                                                                                     switch(error.errorCode) {
                                                                                                                                                                                                                                       case tableau.ErrorCodes.DialogClosedByUser:
                                                                                                                                                                                                                                         console.log("Dialog was closed by user");
                                                                                                                                                                                                                                         break;
                                                                                                                                                                                                                                       default:
                                                                                                                                                                                                                                     console.error(error.message);
                                                                                                                                                                                                                                     }
                                                                                                                                                                                                                                   });
+
                                                                                                                                                                                                                                
 
+
                                                                                                                                                                                                                                1.3.0         A relative path may be used beginning with Tableau 2019.3 and version 1.3.0 of the Extensions API library.
+The relative path must resolve to the directory, or a child directory, of the extension.
+Root-relative paths are not allowed. For example, ./config.html or config.html are allowed,
+but not the root-relative path /config.html.
+Note If your extension is meant for use in versions of Tableau prior to 2019.3,
+you should use an absolute url.
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                              • Experimental
                                                                                                                                                                                                                                Sends a message from the dialog to the host extension or vice versa.
+For dialogs sending messages to extensions, we must listen for the DialogMessageEvent in the extension in order to receive the message.
+For extensions sending messages to dialog, we must listen for the DialogMessageEvent in the dialog code in order to receive the message.
+For two way communication, listen for the DialogMessageEvent in both the dialog and extension code.
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                • message: string
                                                                                                                                                                                                                                  A message to send.
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                • OptionaltargetDialogUrl: string
                                                                                                                                                                                                                                  The url of the dialog to send the message to. If not provided, the message will be sent to the parent extension.
                                                                                                                                                                                                                                  
+

                                                                                                                                                                                                                                    // Sending a message from the dialog to the extension:

                                                                                                                                                                                                                                    // extension code (listening for messages originating from the dialog)
                                                                                                                                                                                                                                    tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
                                                                                                                                                                                                                                      console.log('Message received from dialog: ' + e.message);
                                                                                                                                                                                                                                    })
                                                                                                                                                                                                                                    tableau.extensions.ui.displayDialogAsync(popupUrl);
                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                    // dialog code (sending message to extension)
                                                                                                                                                                                                                                    await tableau.extensions.initializeDialogAsync();
                                                                                                                                                                                                                                    await tableau.extensions.ui.sendDialogMessageAsync('Hello from dialog!');


                                                                                                                                                                                                                                    // Sending a message from the extension to the dialog:

                                                                                                                                                                                                                                    // dialog code (listening for messages originating from the extension)
                                                                                                                                                                                                                                    await tableau.extensions.initializeDialogAsync();
                                                                                                                                                                                                                                    tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
                                                                                                                                                                                                                                      console.log('Message received from extension: ' + e.message);
                                                                                                                                                                                                                                    })
                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                    // extension code (sending message to dialog)
                                                                                                                                                                                                                                    tableau.extensions.ui.displayDialogAsync(popupUrl);
                                                                                                                                                                                                                                    // waiting a bit for dialog to appear before sending message.
                                                                                                                                                                                                                                    // notice the intentional omission of await in calls to displayDialogAsync.
                                                                                                                                                                                                                                    // that's because if we await, we wont run any code after that line until the dialog closes and the promise returns.
                                                                                                                                                                                                                                    setTimeout(() => tableau.extensions.ui.sendDialogMessageAsync('Hello from extension!', popupUrl), 1000);
+
                                                                                                                                                                                                                                  
 
-  // Sending a message from the extension to the dialog:
-
-  // dialog code (listening for messages originating from the extension)
-  await tableau.extensions.initializeDialogAsync();
-  tableau.extensions.ui.addEventListener(tableau.TableauEventType.DialogMessageReceived, (e) => {
-    console.log('Message received from extension: ' + e.message);
-  })
-  ...
-
-  // extension code (sending message to dialog)
-  tableau.extensions.ui.displayDialogAsync(popupUrl);
-  // waiting a bit for dialog to appear before sending message.
-  // notice the intentional omission of await in calls to displayDialogAsync.
-  // that's because if we await, we wont run any code after that line until the dialog closes and the promise returns.
-  setTimeout(() => tableau.extensions.ui.sendDialogMessageAsync('Hello from extension!', popupUrl), 1000);
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          sendDialogMessageToParentAsync

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • sendDialogMessageToParentAsync(message: string): any
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            experimental
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Sends a message from the dialog to the extension or dialog that opened it. - This only works if called from the dialog.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                              message: string
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              A message to send.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Legend

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Module
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Object literal
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Variable
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Function
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Type alias
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Enumeration
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Enumeration member
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Interface
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Class
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Protected property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Protected method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Protected accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Private property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Private method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Private accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Static property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Static method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - - - - - \ No newline at end of file +

                                                                                                                                                                                                                          Returns any

                                                                                                                                                                                                                          • Experimental

                                                                                                                                                                                                                            Sends a message from the dialog to the extension or dialog that opened it. +This only works if called from the dialog.

                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • message: string

                                                                                                                                                                                                                              A message to send.

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                          diff --git a/website/static/api/interfaces/visualspecification.html b/website/static/api/interfaces/visualspecification.html index aef6512d..3381fd2b 100644 --- a/website/static/api/interfaces/visualspecification.html +++ b/website/static/api/interfaces/visualspecification.html @@ -1,254 +1,31 @@ - - - - - - VisualSpecification | Tableau Extensions - - - - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - Options -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - All -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Public
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Public/Protected
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • All
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - Menu -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          Interface VisualSpecification

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          since
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          1.11.0 - Represents a collection of fields on various encodings as well as other viz specific information for a worksheet

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • - VisualSpecification -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          activeMarksSpecificationIndex

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          activeMarksSpecificationIndex: number
                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          columnFields

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          columnFields: FieldInstance[]
                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          marksSpecifications

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          marksSpecifications: MarksSpecification[]
                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                          rowFields

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          rowFields: FieldInstance[]
                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Legend

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Module
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Object literal
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Variable
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Function
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Type alias
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Enumeration
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Enumeration member
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Interface
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Class
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Protected property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Protected method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Protected accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Private property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Private method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Private accessor
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Static property
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Static method
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - - - - - \ No newline at end of file +VisualSpecification | Tableau Extensions API
                                                                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface VisualSpecification

                                                                                                                                                                                                                            1.11.0 +Represents a collection of fields on various encodings as well as other viz specific information for a worksheet

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            interface VisualSpecification {
                                                                                                                                                                                                                                activeMarksSpecificationIndex: number;
                                                                                                                                                                                                                                columnFields: FieldInstance[];
                                                                                                                                                                                                                                marksSpecifications: MarksSpecification[];
                                                                                                                                                                                                                                rowFields: FieldInstance[];
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            activeMarksSpecificationIndex +columnFields +marksSpecifications +rowFields +

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            activeMarksSpecificationIndex: number
                                                                                                                                                                                                                            columnFields: FieldInstance[]
                                                                                                                                                                                                                            marksSpecifications: MarksSpecification[]
                                                                                                                                                                                                                            rowFields: FieldInstance[]

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                            diff --git a/website/static/api/interfaces/workbook.html b/website/static/api/interfaces/workbook.html index abebb987..af05ee44 100644 --- a/website/static/api/interfaces/workbook.html +++ b/website/static/api/interfaces/workbook.html @@ -1,234 +1,33 @@ - - - - - - Workbook | Tableau Extensions - - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - Options -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - All -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Public
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Public/Protected
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • All
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - Menu -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            Interface Workbook

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The Workbook represents the currently open workbook.

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            since
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            1.6.0 and Tableau 2021.3

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - Workbook -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            getAllDataSourcesAsync

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • getAllDataSourcesAsync(): Promise<Array<DataSource>>
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Gets the data sources for this workbook. Note that calling this method might negatively impact performance - and responsiveness of the viz that your extension is added to. The method is not entirely - asynchronous and includes some serial operations.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              since
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              1.6.0 and Tableau 2021.3

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Returns Promise<Array<DataSource>>

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              All data sources used in this workbook.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Legend

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Module
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Object literal
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Variable
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Function
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Function with type parameter
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Type alias
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Type alias with type parameter
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Enumeration
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Enumeration member
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Interface
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Interface with type parameter
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Constructor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Class
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Class with type parameter
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Constructor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Accessor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Index signature
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Inherited constructor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Inherited property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Inherited method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Inherited accessor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Protected property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Protected method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Protected accessor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Private property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Private method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Private accessor
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Static property
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Static method
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - - - - \ No newline at end of file +Workbook | Tableau Extensions API
                                                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface Workbook

                                                                                                                                                                                                                              The Workbook represents the currently open workbook.

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              1.6.0 and Tableau 2021.3

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              interface Workbook {
                                                                                                                                                                                                                                  getAllDataSourcesAsync(): Promise<DataSource[]>;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              getAllDataSourcesAsync +

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              • Gets the data sources for this workbook. Note that calling this method might negatively impact performance +and responsiveness of the viz that your extension is added to. The method is not entirely +asynchronous and includes some serial operations.

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Returns Promise<DataSource[]>

                                                                                                                                                                                                                                All data sources used in this workbook.

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                1.6.0 and Tableau 2021.3

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              diff --git a/website/static/api/interfaces/workbookformatting.html b/website/static/api/interfaces/workbookformatting.html index 70a7fd2e..bfd398cd 100644 --- a/website/static/api/interfaces/workbookformatting.html +++ b/website/static/api/interfaces/workbookformatting.html @@ -1,221 +1,31 @@ - - - - - - WorkbookFormatting | Tableau Extensions - - - - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - Options -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - All -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Public
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Public/Protected
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • All
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - - - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - Menu -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                              Interface WorkbookFormatting

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              The Workbook formatting contains an array of Formatting sheets. - Each of these sheets can be identified by the ClassNameKey and - contains the CSS properties needed to mimic the formatting on your workbook.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • - WorkbookFormatting -
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                              formattingSheets

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              formattingSheets: Array<FormattingSheet>
                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              returns
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              An array of formatting sheets that contain the css properties for a tableau workbook.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              since
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              1.7.0 and Tableau 2021.4

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Legend

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Module
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Object literal
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Variable
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Function
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Function with type parameter
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Type alias
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Type alias with type parameter
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Enumeration
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Enumeration member
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Interface
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Interface with type parameter
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Class
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Class with type parameter
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Constructor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Accessor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Index signature
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Inherited constructor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Inherited property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Inherited method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Inherited accessor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Protected property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Protected method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Protected accessor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Private property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Private method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Private accessor
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Static property
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Static method
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - - - - - \ No newline at end of file +WorkbookFormatting | Tableau Extensions API
                                                                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface WorkbookFormatting

                                                                                                                                                                                                                                The Workbook formatting contains an array of Formatting sheets. +Each of these sheets can be identified by the ClassNameKey and +contains the CSS properties needed to mimic the formatting on your workbook.

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                interface WorkbookFormatting {
                                                                                                                                                                                                                                    formattingSheets: FormattingSheet[];
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                formattingSheets +

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                formattingSheets: FormattingSheet[]

                                                                                                                                                                                                                                An array of formatting sheets that contain the css properties for a tableau workbook.

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                1.7.0 and Tableau 2021.4

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                diff --git a/website/static/api/interfaces/workbookformattingchangedevent.html b/website/static/api/interfaces/workbookformattingchangedevent.html index 69699b45..a43c5d7c 100644 --- a/website/static/api/interfaces/workbookformattingchangedevent.html +++ b/website/static/api/interfaces/workbookformattingchangedevent.html @@ -1,243 +1,30 @@ - - - - - - WorkbookFormattingChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - Options -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - All -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Public
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Public/Protected
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • All
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - Menu -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                Interface WorkbookFormattingChangedEvent

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                An event which is related to a workbook's formatting (worksheet, dashboard, story) in the workbook.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • - TableauEvent -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - WorkbookFormattingChangedEvent -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                formatting

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                formatting: WorkbookFormatting
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                returns
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                The new extension formatting

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                type

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                type: TableauEventType
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                returns
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                The type of event which this class is representing.

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Legend

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Module
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Object literal
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Variable
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Function
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Function with type parameter
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Type alias
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Type alias with type parameter
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Enumeration
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Enumeration member
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Interface
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Interface with type parameter
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Class
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Class with type parameter
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Constructor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Accessor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Index signature
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Inherited constructor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Inherited property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Inherited method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Inherited accessor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Protected property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Protected method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Protected accessor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Private property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Private method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Private accessor
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Static property
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Static method
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - - - - \ No newline at end of file +WorkbookFormattingChangedEvent | Tableau Extensions API
                                                                                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface WorkbookFormattingChangedEvent

                                                                                                                                                                                                                                  An event which is related to a workbook's formatting (worksheet, dashboard, story) in the workbook.

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  interface WorkbookFormattingChangedEvent {
                                                                                                                                                                                                                                      formatting: WorkbookFormatting;
                                                                                                                                                                                                                                      type: TableauEventType;
                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  formatting +type +

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  formatting: WorkbookFormatting

                                                                                                                                                                                                                                  The new extension formatting

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  type: TableauEventType

                                                                                                                                                                                                                                  The type of event which this class is representing.

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                  diff --git a/website/static/api/interfaces/worksheet.html b/website/static/api/interfaces/worksheet.html index 353d07cc..84ed5efc 100644 --- a/website/static/api/interfaces/worksheet.html +++ b/website/static/api/interfaces/worksheet.html @@ -1,1776 +1,368 @@ - - - - - - Worksheet | Tableau Extensions - - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - Options -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - All -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Public
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Public/Protected
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • All
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - Menu -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  Interface Worksheet

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - Sheet -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • - Worksheet -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  All Extensions Properties

                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  Dashboard Extensions Properties

                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  Viz Extensions Properties

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  All Extensions Methods

                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  Viz Extensions Methods

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  All Extensions Properties

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  name

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The name of the sheet.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  sheetType

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  sheetType: SheetType
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The type of the sheet.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  size

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  size: Size
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Size of the sheet.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Dashboard Extensions Properties

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  parentDashboard

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  parentDashboard: Dashboard
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The dashboard object to which this worksheet belongs.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Viz Extensions Properties

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  backgroundColor

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  backgroundColor: string
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The background color of the worksheet.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  formatting

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  formatting: WorksheetFormatting
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Worksheet level formatting.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  All Extensions Methods

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  addEventListener

                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  annotateMarkAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • annotateMarkAsync(mark: MarkInfo, annotationText: string): Promise<void>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Add an annotation to the specified mark. - This is intended to be passed a MarkInfo object received from a DataTable. - MarkInfo can be found in the DataTable returned from getSelectedMarksAsync or getHighlightedMarksAsync.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.4

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how you might call this method using a MarkInfo object.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                       const markCollection = await worksheet.getSelectedMarksAsync();
-   const markToAnnotate = marksCollection.data[0].marksInfo[0];
-   await worksheet.annotateMarkAsync(markToAnnotate, 'Manufacturing line #2 shutdown triggered');
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      mark: MarkInfo
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The mark to annotate.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      annotationText: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The text to display in the annotation.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Empty promise that resolves when the annotation is complete.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  applyFilterAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Applies the list of provided categorical filter values.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      values: Array<string>
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The list of values to filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      updateType: FilterUpdateType
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The update type of this filter (add, all, remove, replace).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      filterOptions: FilterOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Advanced filter options (isExcludeMode).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  applyHierarchicalFilterAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Applies the list of provided hierarchial filter values.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.3

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      values: Array<string> | HierarchicalLevels
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The list of values or levels to filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      updateType: FilterUpdateType
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The update type of this filter (add, all, remove, replace).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      options: FilterOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  applyRangeFilterAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • applyRangeFilterAsync(fieldName: string, filterOptions: RangeFilterOptions): Promise<string>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Applies a range filter to a quantitative or date field.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 Errors will now be thrown for invalid fields or values.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the field to filter on

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      filterOptions: RangeFilterOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Filter Options: min, max, nullOption. At least one of of min and max is required. - For applying date filters, UTC Date objects are expected (that is, var min = new Date(Date.UTC(1999, 0, 1))).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  applyRelativeDateFilterAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Applies a relative date filter.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    version 1.9.0 and Tableau 2022.2

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how to apply a relative date filter from a worksheet.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                     worksheet.applyRelativeDateFilterAsync(
-   'Order Date',
-   {
-     anchorDate: new Date(Date.UTC(2022, 4, 13)),
-     periodType: PeriodType.Years,
-     rangeType: DateRangeType.LastN,
-     rangeN: 1,
-   }
- );
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      options: RelativeDateFilterOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The relative date filter options (anchorDate, periodType, rangeType, rangeN). When the rangeType is LASTN or NEXTN, the rangeN is required.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  clearFilterAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • clearFilterAsync(fieldName: string): Promise<string>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Resets existing filters on the given field. - Categorical filters are reset to "All," and range filters are reset to the full range - Relative date filters can not be reset, consider using the applyRelativeDateFilterAsync API.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      fieldName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the field to clear filter on.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The field to clear filter on.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  clearSelectedMarksAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • clearSelectedMarksAsync(): Promise<void>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Clears selected marks in the current worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Empty promise that resolves when the selection has been cleared.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example assumes that you have some marks already selected in the worksheet. After it has run, - you should have no marks selected, and you should see the console message.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                       worksheet.clearSelectedMarksAsync().then(function () {
-       console.log('Your marks selection has been cleared!');
-   })
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  findParameterAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • findParameterAsync(parameterName: string): Promise<Parameter | undefined>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Searches for a parameter with the given name.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      parameterName: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The name of the parameter to find.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Parameter | undefined>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The parameter with the given name, or undefined if it does not exist.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getAnnotationsAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getAnnotationsAsync(): Promise<Array<Annotation>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Retrieves a list of the annotations in the worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.4

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how you might call this method.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                       let annotations = await worksheet.getAnnotationsAsync();
-   console.log(annotations);
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<Annotation>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A list annotations in the worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getDataSourcesAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getDataSourcesAsync(): Promise<Array<DataSource>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the data sources for this worksheet. Note that calling this method might negatively impact performance - and responsiveness of the viz that your extension is added to. The method is not entirely - asynchronous and includes some serial operations.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<DataSource>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The primary data source and all of the secondary data sources for this worksheet. - By convention the first data source in the array is the primary.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how you might find a specific data source of a worksheet, - using the getDataSourcesAsync() method. The example then chains the data source returned in the promise - to a call to the getUnderlyingDataAsync() method to access the data table.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    worksheet.getDataSourcesAsync().then(datasources => {
-  dataSource = datasources.find(datasource => datasource.name === "Sample - Superstore");
-  return dataSource.getUnderlyingDataAsync();
-}).then(dataTable => {
-// process the dataTable...
-});
-
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getFiltersAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getFiltersAsync(): Promise<Array<Filter>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the list of filters on a worksheet. Hierarchical filters are not yet supported

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<Filter>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A promise that resolves to the collection of filters used in this worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getHighlightedMarksAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the data for the marks which are currently highlighted on the worksheet. - If there are no marks currently highlighted, an empty model is returned.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<MarksCollection>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The marks which are selected.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getParametersAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getParametersAsync(): Promise<Array<Parameter>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<Parameter>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A collection of all the Tableau parameters that are used in this workbook.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getSelectedMarksAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the data for the marks which are currently selected on the worksheet. - If there are no marks currently selected, an empty model is returned.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<MarksCollection>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The marks that are selected.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    // Call to get the selected marks for the worksheet
-worksheet.getSelectedMarksAsync().then(function (marks) {
-  // Get the first DataTable for our selected marks (usually there is just one)
-  const worksheetData = marks.data[0];
+

                                                                                                                                                                                                                                  • Add an annotation to the specified mark. +This is intended to be passed a MarkInfo object received from a DataTable. +MarkInfo can be found in the DataTable returned from getSelectedMarksAsync or getHighlightedMarksAsync.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • mark: MarkInfo

                                                                                                                                                                                                                                      The mark to annotate.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • annotationText: string

                                                                                                                                                                                                                                      The text to display in the annotation.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    Empty promise that resolves when the annotation is complete.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.4

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how you might call this method using a MarkInfo object.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                       const markCollection = await worksheet.getSelectedMarksAsync();
                                                                                                                                                                                                                                       const markToAnnotate = marksCollection.data[0].marksInfo[0];
                                                                                                                                                                                                                                       await worksheet.annotateMarkAsync(markToAnnotate, 'Manufacturing line #2 shutdown triggered');
+
                                                                                                                                                                                                                                    - // Map the data into a format for display, etc. +

                                                                                                                                                                                                                                  • Applies the list of provided categorical filter values.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • fieldName: string

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • values: string[]

                                                                                                                                                                                                                                      The list of values to filter on.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • updateType: FilterUpdateType

                                                                                                                                                                                                                                      The update type of this filter (add, all, remove, replace).

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • filterOptions: FilterOptions

                                                                                                                                                                                                                                      Advanced filter options (isExcludeMode).

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Applies the list of provided hierarchial filter values.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • fieldName: string

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • values: string[] | HierarchicalLevels

                                                                                                                                                                                                                                      The list of values or levels to filter on.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • updateType: FilterUpdateType

                                                                                                                                                                                                                                      The update type of this filter (add, all, remove, replace).

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • options: FilterOptions

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.3

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Applies a range filter to a quantitative or date field.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • fieldName: string

                                                                                                                                                                                                                                      The name of the field to filter on

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • filterOptions: RangeFilterOptions

                                                                                                                                                                                                                                      Filter Options: min, max, nullOption. At least one of of min and max is required. +For applying date filters, UTC Date objects are expected (that is, var min = new Date(Date.UTC(1999, 0, 1))).

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.10.0 Errors will now be thrown for invalid fields or values.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Applies a relative date filter.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • fieldName: string

                                                                                                                                                                                                                                      The name of the field to filter on.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • options: RelativeDateFilterOptions

                                                                                                                                                                                                                                      The relative date filter options (anchorDate, periodType, rangeType, rangeN). When the rangeType is LASTN or NEXTN, the rangeN is required.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    The field name that the filter is applied on.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    version 1.9.0 and Tableau 2022.2

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how to apply a relative date filter from a worksheet.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                     worksheet.applyRelativeDateFilterAsync(
                                                                                                                                                                                                                                       'Order Date',
                                                                                                                                                                                                                                       {
                                                                                                                                                                                                                                         anchorDate: new Date(Date.UTC(2022, 4, 13)),
                                                                                                                                                                                                                                         periodType: PeriodType.Years,
                                                                                                                                                                                                                                         rangeType: DateRangeType.LastN,
                                                                                                                                                                                                                                         rangeN: 1,
                                                                                                                                                                                                                                       }
                                                                                                                                                                                                                                     );
+
                                                                                                                                                                                                                                    -});                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getSummaryColumnsInfoAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getSummaryColumnsInfoAsync(): Promise<Array<Column>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the columns that are returned with getSummaryDataAsync.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.5.0

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<Column>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The array of columns that describe the data in the worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getSummaryDataAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the summary data table for this worksheet. - Warning: getSummaryDataAsync can fail with a worksheet with many rows of data and is now deprecated.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    deprecated
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    since 1.10.0 Use getSummaryDataReaderAsync to avoid failures with many rows of data.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Note: The getSummaryDataAsync and getSummaryDataReaderAsync methods return the data that is currently - in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is - the underlying data without the additional fields and processing you have added in Tableau, use - the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how to replace unsafe usage of getSummaryDataAsync with - getSummaryDataReaderAsync and getAllPagesAsync, assuming you have less than 4,000,000 - rows of data. -

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
-const dataTable = await dataTableReader.getAllPagesAsync();
-await dataTableReader.releaseAsync();
-// ... process data table ...

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how to replace unsafe usage of getSummaryDataAsync with - getSummaryDataReaderAsync and getPageAsync and work with individual - pages.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
-for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
-  const dataTablePage = await dataTableReader.getPageAsync(currentPage);
-  // ... process current page ....
-}
-await dataTableReader.releaseAsync();
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional options: GetSummaryDataOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Collection of options to change the behavior of the call.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<DataTable>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A data table containing the summary data for the worksheet.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getSummaryDataReaderAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets a summary data table reader for this worksheet. - Only one active DataTableReader for summary data is supported.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Note: The getSummaryDataAsync and getSummaryDataReaderAsync methods return the data that is currently - in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is - the underlying data without the additional fields and processing you have added in Tableau, use - the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional pageRowCount: undefined | number
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The number of rows per page. The default and maximum is 10,000 rows.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional options: GetSummaryDataOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Collection of options to change the behavior of the reader.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<DataTableReader>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A data table reader to access the summary data for the worksheet.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows the methods to get and use the summary data reader for all rows in a worksheet.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
-for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
-  let dataTablePage = await dataTableReader.getPageAsync(currentPage);
-  // ... process current page ....
-}
-await dataTableReader.releaseAsync();
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getUnderlyingDataAsync

                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getUnderlyingTableDataAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the underlying data table for the given logical table id. - Use the getUnderlyingTablesAsync method to identify the logical tables.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.4.0

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Note: Use the getUnderlyingTableDataAsync method to access the full data, that is the underlying - data without the parameters, calculated fields, and processing you might have added in Tableau. - To access just the data that is currently in the viz, with parameters, - calculated fields, and sorting applied, use the Worksheet.getSummaryDataAsync and - Worksheet.getSummaryDataReaderAsync methods.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    You can use the getUnderlyingDataOptions.maxRows property to request the number of rows of data to return. - If unspecified (maxRows == '0'), the call to getUnderlyingTableDataAsync requests all rows in the logical table. - Note that the maximum number of rows returned from the getUnderlyingTableDataAsync() method is limited - to 10,000 rows. You can use the DataTable property, isTotalRowCountLimited, to test whether there is - more data. A value of true indicates that the calling function requested more rows than the limit (10,000) and the - underlying data source contains more rows than can be returned.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.5.0 You can use the GetUnderlyingDataOptions.includeDataValuesOption property to optimize performance - by restricting the properties included in the returned DataValues.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    see
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    getUnderlyingTableDataReaderAsync to read more than 10,000 rows.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    const logicalTables = await worksheet.getUnderlyingTablesAsync();
-const dataTable = await worksheet.getUnderlyingTableDataAsync(logicalTables[0].id)
-// process the dataTable...
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      logicalTableId: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      logical table id.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional options: GetUnderlyingDataOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Collection of options to change the behavior of the call.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<DataTable>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A data table containing the underlying data for the given logical table id

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getUnderlyingTableDataReaderAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets a underlying data table reader for the given logical table id. - Use the getUnderlyingTablesAsync method to identify the logical tables. - Only one active DataTableReader per logical table id is supported.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Note: Use the getUnderlyingTableDataReaderAsync method to access the full data, that is - the underlying data without the parameters, calculated fields, and processing you might - have added in Tableau. To access just the data that is currently in the viz, with parameters, - calculated fields, and sorting applied use the Worksheet.getSummaryDataAsync and - Worksheet.getSummaryDataReaderAsync methods.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The getUnderlyingTableDataReaderAsync method attempts to prepare all the rows of the underlying table to be read as pages. - However, there is a limit to the number of rows that can be prepared. The default limit is 1 million rows of data. - You can change the default limit with the Tableau Server (Cloud) or Tableau Desktop option: ExtensionsAndEmbeddingReaderRowLimit. - If the underlying table has many columns, getUnderlyingTableDataReaderAsync can be sped up by only requesting - native data values in the GetUnderlyingDataOptions.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      logicalTableId: string
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      logical table id.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional pageRowCount: undefined | number
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The number of rows per page. The default and maximum is 10,000 rows.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional options: GetUnderlyingDataOptions
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Collection of options to change the behavior of the reader.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<DataTableReader>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    A data table reader to access the underlying data for the given logical table id.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows getting the first page of underlying data.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    // Call to get the underlying logical tables used by the worksheet
-const underlyingTablesData = await worksheet.getUnderlyingTablesAsync();
-const logicalTableId = underlyingTablesData[0].id;
-// Use the above logicalTableId to get the underlying data reader on the active sheet
-const dataTableReader = await worksheet.getUnderlyingTableDataReaderAsync(logicalTableId);
-const page = await dataTableReader.getPageAsync(0);
-// ... process first page of data table ...
-await dataTableReader.releaseAsync();
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getUnderlyingTablesAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getUnderlyingTablesAsync(): Promise<Array<LogicalTable>>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Gets the underlying logical tables used by the worksheet. The resulting logical tables are determined by the measures in the worksheet. - If a worksheet's data source contains multiple logical tables and the worksheet contains only measures from one logical table, this API - will return one logical table.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.4.0

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<Array<LogicalTable>>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    An array of logical tables corresponding to the measures referenced by the worksheet.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    // Call to get the underlying logical tables used by the worksheet
-worksheet.getUnderlyingTablesAsync().then(function (logicalTables) {
-  // Get the first logical table's id
-  const logicalTableId = logicalTables[0].id;
+

                                                                                                                                                                                                                                  • Resets existing filters on the given field. +Categorical filters are reset to "All," and range filters are reset to the full range +Relative date filters can not be reset, consider using the applyRelativeDateFilterAsync API.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • fieldName: string

                                                                                                                                                                                                                                      The name of the field to clear filter on.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                    The field to clear filter on.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Clears selected marks in the current worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    Empty promise that resolves when the selection has been cleared.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example assumes that you have some marks already selected in the worksheet. After it has run, +you should have no marks selected, and you should see the console message.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                       worksheet.clearSelectedMarksAsync().then(function () {
                                                                                                                                                                                                                                           console.log('Your marks selection has been cleared!');
                                                                                                                                                                                                                                       })
+
                                                                                                                                                                                                                                    - // Use the above logicalTableId to then get worksheet's underlying data - // by calling worksheet.getUnderlyingTableDataAsync(logicalTableId) +

                                                                                                                                                                                                                                  • Searches for a parameter with the given name.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • parameterName: string

                                                                                                                                                                                                                                      The name of the parameter to find.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<undefined | Parameter>

                                                                                                                                                                                                                                    The parameter with the given name, or undefined if it does not exist.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Retrieves a list of the annotations in the worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<Annotation[]>

                                                                                                                                                                                                                                    A list annotations in the worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.4

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how you might call this method.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                       let annotations = await worksheet.getAnnotationsAsync();
                                                                                                                                                                                                                                       console.log(annotations);
+
                                                                                                                                                                                                                                    -});                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getVisualSpecificationAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns the visual specification for the worksheet, which can be used to get - the mappings from fields to encodings backing the visual within the worksheet

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.11.0 and Tableau 2024.1

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<VisualSpecification>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Promise containing the VisualSpecification

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  removeAnnotationAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • removeAnnotationAsync(annotation: Annotation): Promise<void>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Removes the corresponding annotation from the worksheet it belongs to. - This is intended to be passed a Annotation object received from getAnnotationsAsync.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 and Tableau 2022.4

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how you might call this method using an annotation.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                       for (const annotation of annotations) {
-     await worksheet.removeAnnotationAsync(annotation);
-   }
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      annotation: Annotation
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The annotation to remove.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Empty promise that resolves when the annotation is removed.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  removeEventListener

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Removes an event listener if a matching one is found. If no matching listener exists, the method does nothing. - The handler function must the handler function specified in the call to the addEventListener method. Alternatively, use the function - returned from the call to addEventListener to unregister the event listener. - For more information, see Events and Event Handling.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Whether or not an event listener was removed.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  selectMarksByValueAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Selects the marks specified by value using the SelectionCriteria interface. - This is intended for manual construction of the desired selections.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.10.0 Errors will now be thrown for invalid fields or values.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The following example shows how you might call this method using state names as the SelectionCriteria. - The SelectionUpdateType is replace (tableau.SelectionUpdateType.Replace), so these values replace - the marks that are currently selected.

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                       worksheet.selectMarksByValueAsync([{
-        fieldName: 'State',
-        value: ['Texas', 'Washington', 'California']
-    }], tableau.SelectionUpdateType.Replace );
-
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      selectionCriteria: Array<SelectionCriteria>
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      A list of criteria for which marks to select.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      updateType: SelectionUpdateType
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      The type of selection to make: add, remove, or replace.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Empty promise that resolves when the selection is complete.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Viz Extensions Methods

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  getTooltipTextAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • getTooltipTextAsync(tupleId: number): Promise<String>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Method to get the text of the tooltip that would be displayed for a given tuple id. Currently supported for web only.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Passing in an invalid tuple id will not throw. -

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    let navigatedTuple = -1;
-let updateScreenReaderElement = (screenReadertext) => {
-  // updates an element to be read out by screen readers
-};
+

                                                                                                                                                                                                                                  • Gets the data sources for this worksheet. Note that calling this method might negatively impact performance +and responsiveness of the viz that your extension is added to. The method is not entirely +asynchronous and includes some serial operations.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<DataSource[]>

                                                                                                                                                                                                                                    The primary data source and all of the secondary data sources for this worksheet. +By convention the first data source in the array is the primary.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how you might find a specific data source of a worksheet, +using the getDataSourcesAsync() method. The example then chains the data source returned in the promise +to a call to the getUnderlyingDataAsync() method to access the data table.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    worksheet.getDataSourcesAsync().then(datasources => {
                                                                                                                                                                                                                                      dataSource = datasources.find(datasource => datasource.name === "Sample - Superstore");
                                                                                                                                                                                                                                      return dataSource.getUnderlyingDataAsync();
                                                                                                                                                                                                                                     }).then(dataTable => {
                                                                                                                                                                                                                                          // process the dataTable...
                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                    -let updateNavigatedTuple = (keyboardEvent) => { - switch (keyboardEvent.key) { - case 'ArrowLeft': - navigatedTuple = navigatedTuple - 1; - break; - case 'ArrowRight': - navigatedTuple = navigatedTuple + 1; - break; - default: - break; - } - // do any work to show visual indication of a mark being navigated to -}; +

                                                                                                                                                                                                                                  • Gets the list of filters on a worksheet. Hierarchical filters are not yet supported

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<Filter[]>

                                                                                                                                                                                                                                    A promise that resolves to the collection of filters used in this worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Gets the data for the marks which are currently highlighted on the worksheet. +If there are no marks currently highlighted, an empty model is returned.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<MarksCollection>

                                                                                                                                                                                                                                    The marks which are selected.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Returns Promise<Parameter[]>

                                                                                                                                                                                                                                    A collection of all the Tableau parameters that are used in this workbook.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Gets the data for the marks which are currently selected on the worksheet. +If there are no marks currently selected, an empty model is returned.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<MarksCollection>

                                                                                                                                                                                                                                    The marks that are selected.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    // Call to get the selected marks for the worksheet
                                                                                                                                                                                                                                    worksheet.getSelectedMarksAsync().then(function (marks) {
                                                                                                                                                                                                                                      // Get the first DataTable for our selected marks (usually there is just one)
                                                                                                                                                                                                                                      const worksheetData = marks.data[0];

                                                                                                                                                                                                                                      // Map the data into a format for display, etc.

                                                                                                                                                                                                                                    });
+
                                                                                                                                                                                                                                    -svg.on('keydown', (keyboardEvent) => { - updateNavigatedTuple(keyboardEvent); - tableau.extensions.worksheetContent.worksheet - .getTooltipTextAsync(navigatedTuple) - .then((response) => { - console.log(response.result); - updateScreenReaderElement(response.result); - }) - .catch((error) => console.log('Failed to get tooltip text because of: ', error)); -});                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      tupleId: number
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<String>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns promise that resolves to a string describing the tooltip text for a given tuple id and rejects on error

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  hoverTupleAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • hoverTupleAsync(hoveredTuple: number, tooltip?: TooltipContext | null, allowHoverActions?: undefined | false | true): Promise<void>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Method to execute hover actions and render tooltip for a given tuple representing a mark in the visualization. - If the tooltip parameter is included it will show the tooltip when the mark is hovered over. - If null or no tooltip parameter is passed, no tooltip is shown. - Hover actions are run by default, but passing false for the allowHoverActions parameter will prevent their execution.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The hoveredTuple parameter is a tuple id. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Passing in an invalid tuple id will not throw and will clear the tooltip. -

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    svg.on('mousemove', (mouseEvent) => {
- const myHoveredTuple = 10;
- tableau.extensions.worksheetContent.worksheet.hoverTupleAsync(myHoveredTuple, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
-   .then(() => console.log('Done'))
-   .catch((error) => console.log('Failed to hover because of: ', error));
- });
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      hoveredTuple: number
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional tooltip: TooltipContext | null
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                      Optional allowHoverActions: undefined | false | true
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  leaveMarkNavigationAsync

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • leaveMarkNavigationAsync(): Promise<void>
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Notifies the scene of a desire to leave mark-level keyboard navigation and return to scene-level keyboard navigation. - Used when implementing keyboard navigation within a visualization, an integral part of building accessibility into a visualization. - Currently supported for the web only. -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    svg.on('keyup', (keyboardEvent) => {
-  if (keyboardEvent.key == "Escape") {
-    tableau.extensions.worksheetContent.worksheet
-      .leaveMarkNavigationAsync()
-      .then(() => console.log('Done'))
-      .catch((error) => console.log('Failed to leave mark-level keyboard navigation because of: ', error));
-  }
-});
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  selectTuplesAsync

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Method to modify selection, execute select actions, and render tooltip for a given list of tuples representing a mark or marks in the visualization. - If the tooltip parameter is included it will show the tooltip when the mark or marks are selected. If not, no tooltip is shown.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The selectedTuples parameter is an array of tuple ids. You can find the tuple id for a row of data by subtracting the index of the row from the total number of rows. - For example, if you have 10 rows, and want to know the tuple id associated with the third row, it will be 7 (10 - 3 = 7). The last row of data will always have the tuple id of 1.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Passing in an invalid tuple id will not throw and will clear the tooltip. -

                                                                                                                                                                                                                                    - 
                                                                                                                                                                                                                                    svg.on('click', (mouseEvent) => {
-const myClickedTuples = [10];
-const ctrlKeyPressed = !!mouseEvent.ctrlKey;
-const selectOption = ctrlKeyPressed ? tableau.SelectOptions.Toggle : tableau.SelectOptions.Simple;
+

                                                                                                                                                                                                                                  • Gets the columns that are returned with getSummaryDataAsync.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Returns Promise<Column[]>

                                                                                                                                                                                                                                    The array of columns that describe the data in the worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.5.0

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  • Gets the summary data table for this worksheet. +Warning: getSummaryDataAsync can fail with a worksheet with many rows of data and is now deprecated.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    Returns Promise<DataTable>

                                                                                                                                                                                                                                    A data table containing the summary data for the worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    since 1.10.0 Use getSummaryDataReaderAsync to avoid failures with many rows of data.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Note

                                                                                                                                                                                                                                    +The getSummaryDataAsync and getSummaryDataReaderAsync methods return the data that is currently +in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is +the underlying data without the additional fields and processing you have added in Tableau, use +the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how to replace unsafe usage of getSummaryDataAsync with +getSummaryDataReaderAsync and getAllPagesAsync, assuming you have less than 4,000,000 +rows of data. +

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
                                                                                                                                                                                                                                    const dataTable = await dataTableReader.getAllPagesAsync();
                                                                                                                                                                                                                                    await dataTableReader.releaseAsync();
                                                                                                                                                                                                                                    // ... process data table ...
+
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows how to replace unsafe usage of getSummaryDataAsync with +getSummaryDataReaderAsync and getPageAsync and work with individual +pages.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
                                                                                                                                                                                                                                    for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
                                                                                                                                                                                                                                      const dataTablePage = await dataTableReader.getPageAsync(currentPage);
                                                                                                                                                                                                                                      // ... process current page ....
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    await dataTableReader.releaseAsync();
+
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                  • Gets a summary data table reader for this worksheet. +Only one active DataTableReader for summary data is supported.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Note

                                                                                                                                                                                                                                    +The getSummaryDataAsync and getSummaryDataReaderAsync methods return the data that is currently +in the viz, with parameters, calculated fields, and sorting applied. To access full data, that is +the underlying data without the additional fields and processing you have added in Tableau, use +the Worksheet.getUnderlyingTableDataAsync and Worksheet.getUnderlyingTableDataReaderAsync methods.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • OptionalpageRowCount: number

                                                                                                                                                                                                                                      The number of rows per page. The default and maximum is 10,000 rows.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • Optionaloptions: GetSummaryDataOptions

                                                                                                                                                                                                                                      Collection of options to change the behavior of the reader.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<DataTableReader>

                                                                                                                                                                                                                                    A data table reader to access the summary data for the worksheet.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    The following example shows the methods to get and use the summary data reader for all rows in a worksheet.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    const dataTableReader = await worksheet.getSummaryDataReaderAsync();
                                                                                                                                                                                                                                    for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
                                                                                                                                                                                                                                      let dataTablePage = await dataTableReader.getPageAsync(currentPage);
                                                                                                                                                                                                                                      // ... process current page ....
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    await dataTableReader.releaseAsync();
+
                                                                                                                                                                                                                                    -tableau.extensions.worksheetContent.worksheet.selectTuplesAsync(myClickedTuples, selectOption, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } }) - .then(() => console.log('Done')) - .catch((error) => console.log('Failed to select because of: ', error)); -});                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                  - +

                                                                                                                                                                                                                                  • Gets the underlying data table for the given logical table id. +Use the getUnderlyingTablesAsync method to identify the logical tables.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • logicalTableId: string

                                                                                                                                                                                                                                      logical table id.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • Optionaloptions: GetUnderlyingDataOptions

                                                                                                                                                                                                                                      Collection of options to change the behavior of the call.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                    Returns Promise<DataTable>

                                                                                                                                                                                                                                    A data table containing the underlying data for the given logical table id

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.4.0

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Note

                                                                                                                                                                                                                                    +Use the getUnderlyingTableDataAsync method to access the full data, that is the underlying +data without the parameters, calculated fields, and processing you might have added in Tableau. +To access just the data that is currently in the viz, with parameters, +calculated fields, and sorting applied, use the Worksheet.getSummaryDataAsync and +Worksheet.getSummaryDataReaderAsync methods.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Legend

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Module
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Object literal
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Variable
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Function
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Type alias
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Interface
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Class
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Protected property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Protected method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Private property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Private method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Static property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Static method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - - - - \ No newline at end of file +

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                    Returns empty promise that resolves when the extension host has successfully been informed of the request and rejects on error

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties - All Extensions
                                                                                                                                                                                                                                  Properties - Dashboard Extensions
                                                                                                                                                                                                                                  Properties - Viz Extensions
                                                                                                                                                                                                                                  Methods - All Extensions
                                                                                                                                                                                                                                  Methods - Viz Extensions
                                                                                                                                                                                                                                  diff --git a/website/static/api/interfaces/worksheetcontent.html b/website/static/api/interfaces/worksheetcontent.html index b90ba971..538bf774 100644 --- a/website/static/api/interfaces/worksheetcontent.html +++ b/website/static/api/interfaces/worksheetcontent.html @@ -1,224 +1,32 @@ - - - - - - WorksheetContent | Tableau Extensions - - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - Options -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - All -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Public
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Public/Protected
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • All
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - Menu -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  Interface WorksheetContent

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The WorksheetContent namespace is the namespace associated with Viz Extensions. - The WorksheetContent namespace contains the Worksheet interface. Use the Worksheet Interface to - access worksheet objects and to add or remove event listeners.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - WorksheetContent -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  worksheet

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  worksheet: Worksheet
                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  returns
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  The worksheet object representing the Tableau - worksheet where the extension is running.

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Legend

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Module
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Object literal
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Variable
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Function
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Function with type parameter
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Type alias
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Type alias with type parameter
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Enumeration
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Enumeration member
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Interface
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Interface with type parameter
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Constructor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Class
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Class with type parameter
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Constructor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Accessor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Index signature
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Inherited constructor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Inherited property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Inherited method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Inherited accessor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Protected property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Protected method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Protected accessor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Private property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Private method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Private accessor
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Static property
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Static method
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - - - - - \ No newline at end of file +WorksheetContent | Tableau Extensions API
                                                                                                                                                                                                                                  Tableau Extensions API
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface WorksheetContent

                                                                                                                                                                                                                                    The WorksheetContent namespace is the namespace associated with Viz Extensions. +The WorksheetContent namespace contains the Worksheet interface. Use the Worksheet Interface to +access worksheet objects and to add or remove event listeners.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    1.12.0 and Tableau 2024.2

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    interface WorksheetContent {
                                                                                                                                                                                                                                        worksheet: Worksheet;
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    worksheet +

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    worksheet: Worksheet

                                                                                                                                                                                                                                    The worksheet object representing the Tableau +worksheet where the extension is running.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    diff --git a/website/static/api/interfaces/worksheetformattingchangedevent.html b/website/static/api/interfaces/worksheetformattingchangedevent.html index dc12fc49..c052df51 100644 --- a/website/static/api/interfaces/worksheetformattingchangedevent.html +++ b/website/static/api/interfaces/worksheetformattingchangedevent.html @@ -1,293 +1,36 @@ - - - - - - WorksheetFormattingChangedEvent | Tableau Extensions - - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - Options -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - All -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Public
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Public/Protected
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • All
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - Menu -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Interface WorksheetFormattingChangedEvent

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    An event raised when the worksheet's formatting changes. - Note that this event is also raised when the workbook's formatting changes.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    1.13 and Tableau 2025.1

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    formatting

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    formatting: WorksheetFormatting
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The new formatting

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    sheet

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    sheet: Sheet
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The sheet which was the source of this event.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    type

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    type: TableauEventType
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The type of event which this class is representing.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    worksheet

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    worksheet: Worksheet
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    returns
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The worksheet which was the source of this event.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Legend

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Module
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Object literal
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Variable
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Function
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Function with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Type alias
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Type alias with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Enumeration
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Enumeration member
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Interface
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Interface with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Class
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Class with type parameter
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Index signature
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Inherited constructor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Inherited accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Protected property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Protected method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Protected accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Private property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Private method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Private accessor
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Static property
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Static method
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - - - - \ No newline at end of file +WorksheetFormattingChangedEvent | Tableau Extensions API
                                                                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface WorksheetFormattingChangedEvent

                                                                                                                                                                                                                                      An event raised when the worksheet's formatting changes. +Note that this event is also raised when the workbook's formatting changes.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      1.13 and Tableau 2025.1

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      interface WorksheetFormattingChangedEvent {
                                                                                                                                                                                                                                          formatting: WorksheetFormatting;
                                                                                                                                                                                                                                          sheet: Sheet;
                                                                                                                                                                                                                                          type: TableauEventType;
                                                                                                                                                                                                                                          worksheet: Worksheet;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      formatting +sheet +type +worksheet +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      formatting: WorksheetFormatting

                                                                                                                                                                                                                                      The new formatting

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      sheet: Sheet

                                                                                                                                                                                                                                      The sheet which was the source of this event.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      type: TableauEventType

                                                                                                                                                                                                                                      The type of event which this class is representing.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      worksheet: Worksheet

                                                                                                                                                                                                                                      The worksheet which was the source of this event.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/website/static/api/modules.html b/website/static/api/modules.html new file mode 100644 index 00000000..18d4adcb --- /dev/null +++ b/website/static/api/modules.html @@ -0,0 +1,25 @@ +Tableau Extensions API
                                                                                                                                                                                                                                      Tableau Extensions API
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                          Tableau Extensions API

                                                                                                                                                                                                                                          Enumerations

                                                                                                                                                                                                                                          AnalyticsObjectType
                                                                                                                                                                                                                                          AnnotationType
                                                                                                                                                                                                                                          ClassNameKey
                                                                                                                                                                                                                                          ColumnType
                                                                                                                                                                                                                                          DashboardLayoutChange
                                                                                                                                                                                                                                          DashboardObjectType
                                                                                                                                                                                                                                          DashboardObjectVisibilityType
                                                                                                                                                                                                                                          DataFormatType
                                                                                                                                                                                                                                          DataType
                                                                                                                                                                                                                                          DateRangeType
                                                                                                                                                                                                                                          DialogStyle
                                                                                                                                                                                                                                          EncodingType
                                                                                                                                                                                                                                          ErrorCodes
                                                                                                                                                                                                                                          ExtensionContext
                                                                                                                                                                                                                                          ExtensionMode
                                                                                                                                                                                                                                          FieldAggregationType
                                                                                                                                                                                                                                          FieldRoleType
                                                                                                                                                                                                                                          FilterDomainType
                                                                                                                                                                                                                                          FilterNullOption
                                                                                                                                                                                                                                          FilterType
                                                                                                                                                                                                                                          FilterUpdateType
                                                                                                                                                                                                                                          HierarchicalLevelSelectionState
                                                                                                                                                                                                                                          IncludeDataValuesOption
                                                                                                                                                                                                                                          MarkType
                                                                                                                                                                                                                                          NegativeNumberFormat
                                                                                                                                                                                                                                          NumberFormatUnits
                                                                                                                                                                                                                                          ParameterValueType
                                                                                                                                                                                                                                          PeriodType
                                                                                                                                                                                                                                          QuickTableCalcType
                                                                                                                                                                                                                                          ReplaySpeedType
                                                                                                                                                                                                                                          SelectionUpdateType
                                                                                                                                                                                                                                          SelectOptions
                                                                                                                                                                                                                                          SharedErrorCodes
                                                                                                                                                                                                                                          SheetType
                                                                                                                                                                                                                                          SortDirection
                                                                                                                                                                                                                                          TableauEventType
                                                                                                                                                                                                                                          TrendLineModelType
                                                                                                                                                                                                                                          VizImageEncodingType
                                                                                                                                                                                                                                          VizImagePaletteType
                                                                                                                                                                                                                                          VizImageSizeSettingAlignmentType
                                                                                                                                                                                                                                          VizImageSizeSettingType
                                                                                                                                                                                                                                          VizImageSortDirectionType

                                                                                                                                                                                                                                          Interfaces - All Extensions

                                                                                                                                                                                                                                          Annotation
                                                                                                                                                                                                                                          CategoricalDomain
                                                                                                                                                                                                                                          CategoricalFilter
                                                                                                                                                                                                                                          Column
                                                                                                                                                                                                                                          ConnectionSummary
                                                                                                                                                                                                                                          DataFormattingOptions
                                                                                                                                                                                                                                          DataSource
                                                                                                                                                                                                                                          DataSourceUnderlyingDataOptions
                                                                                                                                                                                                                                          DataTable
                                                                                                                                                                                                                                          DataTableReader
                                                                                                                                                                                                                                          DataValue
                                                                                                                                                                                                                                          DialogMessageEvent
                                                                                                                                                                                                                                          DialogOptions
                                                                                                                                                                                                                                          Encoding
                                                                                                                                                                                                                                          Environment
                                                                                                                                                                                                                                          EventListenerManager
                                                                                                                                                                                                                                          Extensions
                                                                                                                                                                                                                                          Field
                                                                                                                                                                                                                                          FieldInstance
                                                                                                                                                                                                                                          Filter
                                                                                                                                                                                                                                          FilterChangedEvent
                                                                                                                                                                                                                                          FilterOptions
                                                                                                                                                                                                                                          FormattingSheet
                                                                                                                                                                                                                                          GetSummaryDataOptions
                                                                                                                                                                                                                                          GetUnderlyingDataOptions
                                                                                                                                                                                                                                          HierarchicalFilter
                                                                                                                                                                                                                                          HierarchicalFilterDataValue
                                                                                                                                                                                                                                          HierarchicalLevelDetail
                                                                                                                                                                                                                                          HierarchicalLevels
                                                                                                                                                                                                                                          LogicalTable
                                                                                                                                                                                                                                          MarkInfo
                                                                                                                                                                                                                                          MarksCollection
                                                                                                                                                                                                                                          MarksSelectedEvent
                                                                                                                                                                                                                                          MarksSpecification
                                                                                                                                                                                                                                          Parameter
                                                                                                                                                                                                                                          ParameterChangedEvent
                                                                                                                                                                                                                                          ParameterDomainRestriction
                                                                                                                                                                                                                                          Point
                                                                                                                                                                                                                                          RangeDomain
                                                                                                                                                                                                                                          RangeFilter
                                                                                                                                                                                                                                          RangeFilterOptions
                                                                                                                                                                                                                                          RangeValue
                                                                                                                                                                                                                                          RelativeDateFilter
                                                                                                                                                                                                                                          RelativeDateFilterOptions
                                                                                                                                                                                                                                          SelectionCriteria
                                                                                                                                                                                                                                          Settings
                                                                                                                                                                                                                                          SettingsChangedEvent
                                                                                                                                                                                                                                          Sheet
                                                                                                                                                                                                                                          Size
                                                                                                                                                                                                                                          SummaryDataChangedEvent
                                                                                                                                                                                                                                          TableauError
                                                                                                                                                                                                                                          TableauEvent
                                                                                                                                                                                                                                          TableauSheetEvent
                                                                                                                                                                                                                                          TableauWorksheetEvent
                                                                                                                                                                                                                                          TableSummary
                                                                                                                                                                                                                                          UI
                                                                                                                                                                                                                                          VisualSpecification
                                                                                                                                                                                                                                          Workbook
                                                                                                                                                                                                                                          WorkbookFormatting
                                                                                                                                                                                                                                          WorkbookFormattingChangedEvent
                                                                                                                                                                                                                                          Worksheet
                                                                                                                                                                                                                                          WorksheetFormatting
                                                                                                                                                                                                                                          WorksheetFormattingChangedEvent

                                                                                                                                                                                                                                          Interfaces - Dashboard Extensions

                                                                                                                                                                                                                                          Dashboard
                                                                                                                                                                                                                                          DashboardContent
                                                                                                                                                                                                                                          DashboardLayoutChangedEvent
                                                                                                                                                                                                                                          DashboardObject
                                                                                                                                                                                                                                          DashboardObjectPositionAndSizeUpdate

                                                                                                                                                                                                                                          Interfaces - Viz Extensions

                                                                                                                                                                                                                                          TooltipContext
                                                                                                                                                                                                                                          WorksheetContent

                                                                                                                                                                                                                                          Type Aliases - All Extensions

                                                                                                                                                                                                                                          CategoricalValue
                                                                                                                                                                                                                                          DataFormat
                                                                                                                                                                                                                                          TableauEventHandlerFn
                                                                                                                                                                                                                                          TableauEventUnregisterFn
                                                                                                                                                                                                                                          ZoneVisibilityType

                                                                                                                                                                                                                                          Type Aliases - Dashboard Extensions

                                                                                                                                                                                                                                          DashboardLayoutChangeDetails
                                                                                                                                                                                                                                          DashboardObjectPositionAndSizeUpdateArray
                                                                                                                                                                                                                                          DashboardObjectVisibilityMap
                                                                                                                                                                                                                                          ZoneVisibilityMap

                                                                                                                                                                                                                                          Variables

                                                                                                                                                                                                                                          ZoneVisibilityType

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Enumerations
                                                                                                                                                                                                                                          Interfaces - All Extensions
                                                                                                                                                                                                                                          AnnotationCategoricalDomainCategoricalFilterColumnConnectionSummaryDataFormattingOptionsDataSourceDataSourceUnderlyingDataOptionsDataTableDataTableReaderDataValueDialogMessageEventDialogOptionsEncodingEnvironmentEventListenerManagerExtensionsFieldFieldInstanceFilterFilterChangedEventFilterOptionsFormattingSheetGetSummaryDataOptionsGetUnderlyingDataOptionsHierarchicalFilterHierarchicalFilterDataValueHierarchicalLevelDetailHierarchicalLevelsLogicalTableMarkInfoMarksCollectionMarksSelectedEventMarksSpecificationParameterParameterChangedEventParameterDomainRestrictionPointRangeDomainRangeFilterRangeFilterOptionsRangeValueRelativeDateFilterRelativeDateFilterOptionsSelectionCriteriaSettingsSettingsChangedEventSheetSizeSummaryDataChangedEventTableauErrorTableauEventTableauSheetEventTableauWorksheetEventTableSummaryUIVisualSpecificationWorkbookWorkbookFormattingWorkbookFormattingChangedEventWorksheetWorksheetFormattingWorksheetFormattingChangedEvent
                                                                                                                                                                                                                                          Interfaces - Dashboard Extensions
                                                                                                                                                                                                                                          Interfaces - Viz Extensions
                                                                                                                                                                                                                                          Type Aliases - All Extensions
                                                                                                                                                                                                                                          Type Aliases - Dashboard Extensions
                                                                                                                                                                                                                                          Variables
                                                                                                                                                                                                                                          diff --git a/website/static/api/modules/tableau.html b/website/static/api/modules/tableau.html deleted file mode 100644 index a77dbf7b..00000000 --- a/website/static/api/modules/tableau.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - Tableau | Tableau Extensions - - - - - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - Options -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - All -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Public
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Public/Protected
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • All
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - - - - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - Menu -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                          Module Tableau

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          The tableau namespace exists for organization and to avoid polluting - the global namespace. It contains no constructs other than sub-namespaces and the Tableau enumerations.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Enumerations

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Type aliases

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Variables

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Object literals

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Type aliases

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                          ZoneVisibilityType

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          ZoneVisibilityType: DashboardObjectVisibilityType
                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          ZoneVisibilityType

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          deprecated
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          use DashboardObjectVisibilityType

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Variables

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                          Let extensions

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          extensions: Extensions
                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Object literals

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                          Const ZoneVisibilityType

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          ZoneVisibilityType: object
                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Legend

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Module
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Object literal
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Variable
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Function
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Function with type parameter
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Type alias
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Type alias with type parameter
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Enumeration
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Enumeration member
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Interface
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Interface with type parameter
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Class
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Class with type parameter
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Constructor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Accessor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Index signature
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Inherited constructor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Inherited property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Inherited method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Inherited accessor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Protected property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Protected method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Protected accessor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Private property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Private method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Private accessor
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Static property
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Static method
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - - - - - \ No newline at end of file diff --git a/website/static/api/types/CategoricalValue.html b/website/static/api/types/CategoricalValue.html new file mode 100644 index 00000000..c90ef929 --- /dev/null +++ b/website/static/api/types/CategoricalValue.html @@ -0,0 +1,26 @@ +CategoricalValue | Tableau Extensions API
                                                                                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Type Alias CategoricalValue

                                                                                                                                                                                                                                            CategoricalValue: string | string[]

                                                                                                                                                                                                                                            Categorical values for selection.

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            diff --git a/website/static/api/types/DashboardLayoutChangeDetails.html b/website/static/api/types/DashboardLayoutChangeDetails.html new file mode 100644 index 00000000..0fbed02f --- /dev/null +++ b/website/static/api/types/DashboardLayoutChangeDetails.html @@ -0,0 +1,26 @@ +DashboardLayoutChangeDetails | Tableau Extensions API
                                                                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Type Alias DashboardLayoutChangeDetails

                                                                                                                                                                                                                                              DashboardLayoutChangeDetails: Map<number, DashboardLayoutChange[]>

                                                                                                                                                                                                                                              Map object that is used for the DashboardLayoutChangedEvent.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                              diff --git a/website/static/api/types/DashboardObjectPositionAndSizeUpdateArray.html b/website/static/api/types/DashboardObjectPositionAndSizeUpdateArray.html new file mode 100644 index 00000000..8fa3d3ea --- /dev/null +++ b/website/static/api/types/DashboardObjectPositionAndSizeUpdateArray.html @@ -0,0 +1,26 @@ +DashboardObjectPositionAndSizeUpdateArray | Tableau Extensions API
                                                                                                                                                                                                                                              Tableau Extensions API
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Type Alias DashboardObjectPositionAndSizeUpdateArray

                                                                                                                                                                                                                                                DashboardObjectPositionAndSizeUpdateArray: DashboardObjectPositionAndSizeUpdate[]

                                                                                                                                                                                                                                                Array object that can be passed into moveAndResizeDashboardObjects.

                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                diff --git a/website/static/api/types/DashboardObjectVisibilityMap.html b/website/static/api/types/DashboardObjectVisibilityMap.html new file mode 100644 index 00000000..485ac2e8 --- /dev/null +++ b/website/static/api/types/DashboardObjectVisibilityMap.html @@ -0,0 +1,26 @@ +DashboardObjectVisibilityMap | Tableau Extensions API
                                                                                                                                                                                                                                                Tableau Extensions API
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Type Alias DashboardObjectVisibilityMap

                                                                                                                                                                                                                                                  DashboardObjectVisibilityMap: Map<number, DashboardObjectVisibilityType>

                                                                                                                                                                                                                                                  Map object that can be passed into setDashboardObjectVisibilityAsync.

                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                  diff --git a/website/static/api/types/DataFormat.html b/website/static/api/types/DataFormat.html new file mode 100644 index 00000000..a236293e --- /dev/null +++ b/website/static/api/types/DataFormat.html @@ -0,0 +1,35 @@ +DataFormat | Tableau Extensions API
                                                                                                                                                                                                                                                  Tableau Extensions API
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Type Alias DataFormat

                                                                                                                                                                                                                                                    1.16.0 +Formatting options for a number or date column

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    type DataFormat = {
                                                                                                                                                                                                                                                        axisOptions?: DataFormattingOptions;
                                                                                                                                                                                                                                                        defaultOptions: DataFormattingOptions;
                                                                                                                                                                                                                                                        subtotalsOptions?: DataFormattingOptions;
                                                                                                                                                                                                                                                        totalsOptions?: DataFormattingOptions;
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    axisOptions? +defaultOptions +subtotalsOptions? +totalsOptions? +

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    axisOptions?: DataFormattingOptions

                                                                                                                                                                                                                                                    Formatting oprions for the field's axis.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    defaultOptions: DataFormattingOptions

                                                                                                                                                                                                                                                    The default formatting options for each mark.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    subtotalsOptions?: DataFormattingOptions

                                                                                                                                                                                                                                                    The subtotals formatting options for a group of marks.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    totalsOptions?: DataFormattingOptions

                                                                                                                                                                                                                                                    The totals formatting options for all marks.

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                    diff --git a/website/static/api/types/TableauEventHandlerFn.html b/website/static/api/types/TableauEventHandlerFn.html new file mode 100644 index 00000000..c45676c8 --- /dev/null +++ b/website/static/api/types/TableauEventHandlerFn.html @@ -0,0 +1,27 @@ +TableauEventHandlerFn | Tableau Extensions API
                                                                                                                                                                                                                                                    Tableau Extensions API
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Type Alias TableauEventHandlerFn

                                                                                                                                                                                                                                                      TableauEventHandlerFn: (event: TableauEvent) => void

                                                                                                                                                                                                                                                      Callback function which will be invoked when an event notification is emitted.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                      diff --git a/website/static/api/types/TableauEventUnregisterFn.html b/website/static/api/types/TableauEventUnregisterFn.html new file mode 100644 index 00000000..168117b2 --- /dev/null +++ b/website/static/api/types/TableauEventUnregisterFn.html @@ -0,0 +1,28 @@ +TableauEventUnregisterFn | Tableau Extensions API
                                                                                                                                                                                                                                                      Tableau Extensions API
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Type Alias TableauEventUnregisterFn

                                                                                                                                                                                                                                                        TableauEventUnregisterFn: () => boolean

                                                                                                                                                                                                                                                        Function which can be invoked to remove an event handler registration. This will be +returned when registering an event and makes unregistering simpler.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                          • (): boolean

                                                                                                                                                                                                                                                          • Returns boolean

                                                                                                                                                                                                                                                            Whether or not the unregistration was successful.

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        diff --git a/website/static/api/types/ZoneVisibilityMap.html b/website/static/api/types/ZoneVisibilityMap.html new file mode 100644 index 00000000..01145f0d --- /dev/null +++ b/website/static/api/types/ZoneVisibilityMap.html @@ -0,0 +1,26 @@ +ZoneVisibilityMap | Tableau Extensions API
                                                                                                                                                                                                                                                        Tableau Extensions API
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Type Alias ZoneVisibilityMap

                                                                                                                                                                                                                                                          ZoneVisibilityMap: Map<number, ZoneVisibilityType> | object

                                                                                                                                                                                                                                                          Map object that can be passed into setZoneVisibilityAsync.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          diff --git a/website/static/api/types/ZoneVisibilityType.html b/website/static/api/types/ZoneVisibilityType.html new file mode 100644 index 00000000..e70dbaa6 --- /dev/null +++ b/website/static/api/types/ZoneVisibilityType.html @@ -0,0 +1,27 @@ +ZoneVisibilityType | Tableau Extensions API
                                                                                                                                                                                                                                                          Tableau Extensions API
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Type Alias ZoneVisibilityType

                                                                                                                                                                                                                                                            ZoneVisibilityType: DashboardObjectVisibilityType

                                                                                                                                                                                                                                                            ZoneVisibilityType

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            use DashboardObjectVisibilityType

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            diff --git a/website/static/api/variables/ZoneVisibilityType.html b/website/static/api/variables/ZoneVisibilityType.html new file mode 100644 index 00000000..75d9f27c --- /dev/null +++ b/website/static/api/variables/ZoneVisibilityType.html @@ -0,0 +1,25 @@ +ZoneVisibilityType | Tableau Extensions API
                                                                                                                                                                                                                                                            Tableau Extensions API
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Variable ZoneVisibilityType

                                                                                                                                                                                                                                                              ZoneVisibilityType: { Hide: Hide; Show: Show }

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              From bdcfa659d79e3ca432847f099772d30f272f8716 Mon Sep 17 00:00:00 2001 From: Dave Hagen <3d.hagen@gmail.com> Date: Wed, 17 Jun 2026 22:00:46 -0700 Subject: [PATCH 3/4] Update yarn.lock Routine dependency update: caniuse-lite version bump and react-helmet-async deduplication. Co-Authored-By: Claude Sonnet 4.6 --- website/yarn.lock | 26 +++++--------------------- 1 file changed, 5 insertions(+), 21 deletions(-) diff --git a/website/yarn.lock b/website/yarn.lock index f3350d55..8e2aac2d 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -5857,15 +5857,10 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001587, caniuse-lite@^1.0.30001591, caniuse-lite@^1.0.30001599: - version "1.0.30001669" - resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001669.tgz" - integrity sha512-DlWzFDJqstqtIVx1zeSpIMLjunf5SmwOw0N2Ck/QSQdS8PLS4+9HrLaYei4w8BIAL7IB/UEDu889d8vhCTPA0w== - -caniuse-lite@^1.0.30001688: - version "1.0.30001690" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001690.tgz#f2d15e3aaf8e18f76b2b8c1481abde063b8104c8" - integrity sha512-5ExiE3qQN6oF8Clf8ifIDcMRCRE/dMGcETG/XGMD8/XiXm6HXQgQTh1yZYLXXpSOsEUlJm1Xr7kGULZTuGtP/w== +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001587, caniuse-lite@^1.0.30001591, caniuse-lite@^1.0.30001599, caniuse-lite@^1.0.30001688: + version "1.0.30001799" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001799.tgz" + integrity sha512-hG1bReV+OUU+MOqK4t/ZWI0tZOyz3rqS9XuhOUz1cIcbwBKjOyJEJuw9ER5JuNyqxNk8u/JUVbGibBOL1yrjFw== ccount@^2.0.0: version "2.0.1" @@ -11095,18 +11090,7 @@ react-fast-compare@^3.2.0: resolved "https://registry.npmjs.org/react-fast-compare/-/react-fast-compare-3.2.1.tgz" integrity sha512-xTYf9zFim2pEif/Fw16dBiXpe0hoy5PxcD8+OwBnTtNLfIm3g6WxhKNurY+6OmdH1u6Ta/W/Vl6vjbYP1MFnDg== -react-helmet-async@*, react-helmet-async@^1.3.0: - version "1.3.0" - resolved "https://registry.npmjs.org/react-helmet-async/-/react-helmet-async-1.3.0.tgz" - integrity sha512-9jZ57/dAn9t3q6hneQS0wukqC2ENOBgMNVEhb/ZG9ZSxUetzVIw4iAmEU38IaVg3QGYauQPhSeUTuIUtFglWpg== - dependencies: - "@babel/runtime" "^7.12.5" - invariant "^2.2.4" - prop-types "^15.7.2" - react-fast-compare "^3.2.0" - shallowequal "^1.1.0" - -"react-helmet-async@npm:@slorber/react-helmet-async@*", "react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": +react-helmet-async@*, react-helmet-async@^1.3.0, "react-helmet-async@npm:@slorber/react-helmet-async@*", "react-helmet-async@npm:@slorber/react-helmet-async@1.3.0": version "1.3.0" resolved "https://registry.yarnpkg.com/@slorber/react-helmet-async/-/react-helmet-async-1.3.0.tgz#11fbc6094605cf60aa04a28c17e0aab894b4ecff" integrity sha512-e9/OK8VhwUSc67diWI8Rb3I0YgI9/SBQtnhe9aEuK6MhZm7ntZZimXgwXnd8W96YTmSOb9M4d8LwhRZyhWr/1A== From 1c3309efc039dbd083d87c5c8504a10c5622aecd Mon Sep 17 00:00:00 2001 From: Dave Hagen <3d.hagen@gmail.com> Date: Wed, 17 Jun 2026 22:49:03 -0700 Subject: [PATCH 4/4] Fix case-sensitive filenames for GitHub deployment macOS case-insensitive filesystem caused git to track PascalCase TypeDoc files under their old lowercase names. Use git mv renames so GitHub (Linux, case-sensitive) sees the correct PascalCase filenames. Also set core.ignoreCase = false to prevent recurrence. Co-Authored-By: Claude Sonnet 4.6 --- .../api/enums/{sharederrorcodes.html => SharedErrorCodes.html} | 0 .../static/api/interfaces/{annotation.html => Annotation.html} | 0 .../interfaces/{categoricaldomain.html => CategoricalDomain.html} | 0 .../interfaces/{categoricalfilter.html => CategoricalFilter.html} | 0 website/static/api/interfaces/{column.html => Column.html} | 0 .../interfaces/{connectionsummary.html => ConnectionSummary.html} | 0 website/static/api/interfaces/{dashboard.html => Dashboard.html} | 0 .../interfaces/{dashboardcontent.html => DashboardContent.html} | 0 ...rdlayoutchangedevent.html => DashboardLayoutChangedEvent.html} | 0 .../api/interfaces/{dashboardobject.html => DashboardObject.html} | 0 ...dsizeupdate.html => DashboardObjectPositionAndSizeUpdate.html} | 0 .../static/api/interfaces/{datasource.html => DataSource.html} | 0 ...lyingdataoptions.html => DataSourceUnderlyingDataOptions.html} | 0 website/static/api/interfaces/{datatable.html => DataTable.html} | 0 .../api/interfaces/{datatablereader.html => DataTableReader.html} | 0 website/static/api/interfaces/{datavalue.html => DataValue.html} | 0 .../{dialogmessageevent.html => DialogMessageEvent.html} | 0 .../api/interfaces/{dialogoptions.html => DialogOptions.html} | 0 website/static/api/interfaces/{encoding.html => Encoding.html} | 0 .../static/api/interfaces/{environment.html => Environment.html} | 0 .../{eventlistenermanager.html => EventListenerManager.html} | 0 .../static/api/interfaces/{extensions.html => Extensions.html} | 0 website/static/api/interfaces/{field.html => Field.html} | 0 .../api/interfaces/{fieldinstance.html => FieldInstance.html} | 0 website/static/api/interfaces/{filter.html => Filter.html} | 0 .../{filterchangedevent.html => FilterChangedEvent.html} | 0 .../api/interfaces/{filteroptions.html => FilterOptions.html} | 0 .../api/interfaces/{formattingsheet.html => FormattingSheet.html} | 0 .../{getsummarydataoptions.html => GetSummaryDataOptions.html} | 0 ...etunderlyingdataoptions.html => GetUnderlyingDataOptions.html} | 0 .../{hierarchicalfilter.html => HierarchicalFilter.html} | 0 ...hicalfilterdatavalue.html => HierarchicalFilterDataValue.html} | 0 ...{hierarchicalleveldetail.html => HierarchicalLevelDetail.html} | 0 .../{hierarchicallevels.html => HierarchicalLevels.html} | 0 .../api/interfaces/{logicaltable.html => LogicalTable.html} | 0 website/static/api/interfaces/{markinfo.html => MarkInfo.html} | 0 .../api/interfaces/{markscollection.html => MarksCollection.html} | 0 .../{marksselectedevent.html => MarksSelectedEvent.html} | 0 .../{marksspecification.html => MarksSpecification.html} | 0 website/static/api/interfaces/{parameter.html => Parameter.html} | 0 .../{parameterchangedevent.html => ParameterChangedEvent.html} | 0 ...eterdomainrestriction.html => ParameterDomainRestriction.html} | 0 website/static/api/interfaces/{point.html => Point.html} | 0 .../static/api/interfaces/{rangedomain.html => RangeDomain.html} | 0 .../static/api/interfaces/{rangefilter.html => RangeFilter.html} | 0 .../{rangefilteroptions.html => RangeFilterOptions.html} | 0 .../static/api/interfaces/{rangevalue.html => RangeValue.html} | 0 .../{relativedatefilter.html => RelativeDateFilter.html} | 0 ...ativedatefilteroptions.html => RelativeDateFilterOptions.html} | 0 .../interfaces/{selectioncriteria.html => SelectionCriteria.html} | 0 website/static/api/interfaces/{settings.html => Settings.html} | 0 .../{settingschangedevent.html => SettingsChangedEvent.html} | 0 website/static/api/interfaces/{sheet.html => Sheet.html} | 0 website/static/api/interfaces/{size.html => Size.html} | 0 ...{summarydatachangedevent.html => SummaryDataChangedEvent.html} | 0 .../api/interfaces/{tablesummary.html => TableSummary.html} | 0 .../api/interfaces/{tableauerror.html => TableauError.html} | 0 .../api/interfaces/{tableauevent.html => TableauEvent.html} | 0 .../interfaces/{tableausheetevent.html => TableauSheetEvent.html} | 0 .../{tableauworksheetevent.html => TableauWorksheetEvent.html} | 0 .../api/interfaces/{tooltipcontext.html => TooltipContext.html} | 0 website/static/api/interfaces/{ui.html => UI.html} | 0 .../{visualspecification.html => VisualSpecification.html} | 0 website/static/api/interfaces/{workbook.html => Workbook.html} | 0 .../{workbookformatting.html => WorkbookFormatting.html} | 0 ...ttingchangedevent.html => WorkbookFormattingChangedEvent.html} | 0 website/static/api/interfaces/{worksheet.html => Worksheet.html} | 0 .../interfaces/{worksheetcontent.html => WorksheetContent.html} | 0 ...tingchangedevent.html => WorksheetFormattingChangedEvent.html} | 0 69 files changed, 0 insertions(+), 0 deletions(-) rename website/static/api/enums/{sharederrorcodes.html => SharedErrorCodes.html} (100%) rename website/static/api/interfaces/{annotation.html => Annotation.html} (100%) rename website/static/api/interfaces/{categoricaldomain.html => CategoricalDomain.html} (100%) rename website/static/api/interfaces/{categoricalfilter.html => CategoricalFilter.html} (100%) rename website/static/api/interfaces/{column.html => Column.html} (100%) rename website/static/api/interfaces/{connectionsummary.html => ConnectionSummary.html} (100%) rename website/static/api/interfaces/{dashboard.html => Dashboard.html} (100%) rename website/static/api/interfaces/{dashboardcontent.html => DashboardContent.html} (100%) rename website/static/api/interfaces/{dashboardlayoutchangedevent.html => DashboardLayoutChangedEvent.html} (100%) rename website/static/api/interfaces/{dashboardobject.html => DashboardObject.html} (100%) rename website/static/api/interfaces/{dashboardobjectpositionandsizeupdate.html => DashboardObjectPositionAndSizeUpdate.html} (100%) rename website/static/api/interfaces/{datasource.html => DataSource.html} (100%) rename website/static/api/interfaces/{datasourceunderlyingdataoptions.html => DataSourceUnderlyingDataOptions.html} (100%) rename website/static/api/interfaces/{datatable.html => DataTable.html} (100%) rename website/static/api/interfaces/{datatablereader.html => DataTableReader.html} (100%) rename website/static/api/interfaces/{datavalue.html => DataValue.html} (100%) rename website/static/api/interfaces/{dialogmessageevent.html => DialogMessageEvent.html} (100%) rename website/static/api/interfaces/{dialogoptions.html => DialogOptions.html} (100%) rename website/static/api/interfaces/{encoding.html => Encoding.html} (100%) rename website/static/api/interfaces/{environment.html => Environment.html} (100%) rename website/static/api/interfaces/{eventlistenermanager.html => EventListenerManager.html} (100%) rename website/static/api/interfaces/{extensions.html => Extensions.html} (100%) rename website/static/api/interfaces/{field.html => Field.html} (100%) rename website/static/api/interfaces/{fieldinstance.html => FieldInstance.html} (100%) rename website/static/api/interfaces/{filter.html => Filter.html} (100%) rename website/static/api/interfaces/{filterchangedevent.html => FilterChangedEvent.html} (100%) rename website/static/api/interfaces/{filteroptions.html => FilterOptions.html} (100%) rename website/static/api/interfaces/{formattingsheet.html => FormattingSheet.html} (100%) rename website/static/api/interfaces/{getsummarydataoptions.html => GetSummaryDataOptions.html} (100%) rename website/static/api/interfaces/{getunderlyingdataoptions.html => GetUnderlyingDataOptions.html} (100%) rename website/static/api/interfaces/{hierarchicalfilter.html => HierarchicalFilter.html} (100%) rename website/static/api/interfaces/{hierarchicalfilterdatavalue.html => HierarchicalFilterDataValue.html} (100%) rename website/static/api/interfaces/{hierarchicalleveldetail.html => HierarchicalLevelDetail.html} (100%) rename website/static/api/interfaces/{hierarchicallevels.html => HierarchicalLevels.html} (100%) rename website/static/api/interfaces/{logicaltable.html => LogicalTable.html} (100%) rename website/static/api/interfaces/{markinfo.html => MarkInfo.html} (100%) rename website/static/api/interfaces/{markscollection.html => MarksCollection.html} (100%) rename website/static/api/interfaces/{marksselectedevent.html => MarksSelectedEvent.html} (100%) rename website/static/api/interfaces/{marksspecification.html => MarksSpecification.html} (100%) rename website/static/api/interfaces/{parameter.html => Parameter.html} (100%) rename website/static/api/interfaces/{parameterchangedevent.html => ParameterChangedEvent.html} (100%) rename website/static/api/interfaces/{parameterdomainrestriction.html => ParameterDomainRestriction.html} (100%) rename website/static/api/interfaces/{point.html => Point.html} (100%) rename website/static/api/interfaces/{rangedomain.html => RangeDomain.html} (100%) rename website/static/api/interfaces/{rangefilter.html => RangeFilter.html} (100%) rename website/static/api/interfaces/{rangefilteroptions.html => RangeFilterOptions.html} (100%) rename website/static/api/interfaces/{rangevalue.html => RangeValue.html} (100%) rename website/static/api/interfaces/{relativedatefilter.html => RelativeDateFilter.html} (100%) rename website/static/api/interfaces/{relativedatefilteroptions.html => RelativeDateFilterOptions.html} (100%) rename website/static/api/interfaces/{selectioncriteria.html => SelectionCriteria.html} (100%) rename website/static/api/interfaces/{settings.html => Settings.html} (100%) rename website/static/api/interfaces/{settingschangedevent.html => SettingsChangedEvent.html} (100%) rename website/static/api/interfaces/{sheet.html => Sheet.html} (100%) rename website/static/api/interfaces/{size.html => Size.html} (100%) rename website/static/api/interfaces/{summarydatachangedevent.html => SummaryDataChangedEvent.html} (100%) rename website/static/api/interfaces/{tablesummary.html => TableSummary.html} (100%) rename website/static/api/interfaces/{tableauerror.html => TableauError.html} (100%) rename website/static/api/interfaces/{tableauevent.html => TableauEvent.html} (100%) rename website/static/api/interfaces/{tableausheetevent.html => TableauSheetEvent.html} (100%) rename website/static/api/interfaces/{tableauworksheetevent.html => TableauWorksheetEvent.html} (100%) rename website/static/api/interfaces/{tooltipcontext.html => TooltipContext.html} (100%) rename website/static/api/interfaces/{ui.html => UI.html} (100%) rename website/static/api/interfaces/{visualspecification.html => VisualSpecification.html} (100%) rename website/static/api/interfaces/{workbook.html => Workbook.html} (100%) rename website/static/api/interfaces/{workbookformatting.html => WorkbookFormatting.html} (100%) rename website/static/api/interfaces/{workbookformattingchangedevent.html => WorkbookFormattingChangedEvent.html} (100%) rename website/static/api/interfaces/{worksheet.html => Worksheet.html} (100%) rename website/static/api/interfaces/{worksheetcontent.html => WorksheetContent.html} (100%) rename website/static/api/interfaces/{worksheetformattingchangedevent.html => WorksheetFormattingChangedEvent.html} (100%) diff --git a/website/static/api/enums/sharederrorcodes.html b/website/static/api/enums/SharedErrorCodes.html similarity index 100% rename from website/static/api/enums/sharederrorcodes.html rename to website/static/api/enums/SharedErrorCodes.html diff --git a/website/static/api/interfaces/annotation.html b/website/static/api/interfaces/Annotation.html similarity index 100% rename from website/static/api/interfaces/annotation.html rename to website/static/api/interfaces/Annotation.html diff --git a/website/static/api/interfaces/categoricaldomain.html b/website/static/api/interfaces/CategoricalDomain.html similarity index 100% rename from website/static/api/interfaces/categoricaldomain.html rename to website/static/api/interfaces/CategoricalDomain.html diff --git a/website/static/api/interfaces/categoricalfilter.html b/website/static/api/interfaces/CategoricalFilter.html similarity index 100% rename from website/static/api/interfaces/categoricalfilter.html rename to website/static/api/interfaces/CategoricalFilter.html diff --git a/website/static/api/interfaces/column.html b/website/static/api/interfaces/Column.html similarity index 100% rename from website/static/api/interfaces/column.html rename to website/static/api/interfaces/Column.html diff --git a/website/static/api/interfaces/connectionsummary.html b/website/static/api/interfaces/ConnectionSummary.html similarity index 100% rename from website/static/api/interfaces/connectionsummary.html rename to website/static/api/interfaces/ConnectionSummary.html diff --git a/website/static/api/interfaces/dashboard.html b/website/static/api/interfaces/Dashboard.html similarity index 100% rename from website/static/api/interfaces/dashboard.html rename to website/static/api/interfaces/Dashboard.html diff --git a/website/static/api/interfaces/dashboardcontent.html b/website/static/api/interfaces/DashboardContent.html similarity index 100% rename from website/static/api/interfaces/dashboardcontent.html rename to website/static/api/interfaces/DashboardContent.html diff --git a/website/static/api/interfaces/dashboardlayoutchangedevent.html b/website/static/api/interfaces/DashboardLayoutChangedEvent.html similarity index 100% rename from website/static/api/interfaces/dashboardlayoutchangedevent.html rename to website/static/api/interfaces/DashboardLayoutChangedEvent.html diff --git a/website/static/api/interfaces/dashboardobject.html b/website/static/api/interfaces/DashboardObject.html similarity index 100% rename from website/static/api/interfaces/dashboardobject.html rename to website/static/api/interfaces/DashboardObject.html diff --git a/website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html b/website/static/api/interfaces/DashboardObjectPositionAndSizeUpdate.html similarity index 100% rename from website/static/api/interfaces/dashboardobjectpositionandsizeupdate.html rename to website/static/api/interfaces/DashboardObjectPositionAndSizeUpdate.html diff --git a/website/static/api/interfaces/datasource.html b/website/static/api/interfaces/DataSource.html similarity index 100% rename from website/static/api/interfaces/datasource.html rename to website/static/api/interfaces/DataSource.html diff --git a/website/static/api/interfaces/datasourceunderlyingdataoptions.html b/website/static/api/interfaces/DataSourceUnderlyingDataOptions.html similarity index 100% rename from website/static/api/interfaces/datasourceunderlyingdataoptions.html rename to website/static/api/interfaces/DataSourceUnderlyingDataOptions.html diff --git a/website/static/api/interfaces/datatable.html b/website/static/api/interfaces/DataTable.html similarity index 100% rename from website/static/api/interfaces/datatable.html rename to website/static/api/interfaces/DataTable.html diff --git a/website/static/api/interfaces/datatablereader.html b/website/static/api/interfaces/DataTableReader.html similarity index 100% rename from website/static/api/interfaces/datatablereader.html rename to website/static/api/interfaces/DataTableReader.html diff --git a/website/static/api/interfaces/datavalue.html b/website/static/api/interfaces/DataValue.html similarity index 100% rename from website/static/api/interfaces/datavalue.html rename to website/static/api/interfaces/DataValue.html diff --git a/website/static/api/interfaces/dialogmessageevent.html b/website/static/api/interfaces/DialogMessageEvent.html similarity index 100% rename from website/static/api/interfaces/dialogmessageevent.html rename to website/static/api/interfaces/DialogMessageEvent.html diff --git a/website/static/api/interfaces/dialogoptions.html b/website/static/api/interfaces/DialogOptions.html similarity index 100% rename from website/static/api/interfaces/dialogoptions.html rename to website/static/api/interfaces/DialogOptions.html diff --git a/website/static/api/interfaces/encoding.html b/website/static/api/interfaces/Encoding.html similarity index 100% rename from website/static/api/interfaces/encoding.html rename to website/static/api/interfaces/Encoding.html diff --git a/website/static/api/interfaces/environment.html b/website/static/api/interfaces/Environment.html similarity index 100% rename from website/static/api/interfaces/environment.html rename to website/static/api/interfaces/Environment.html diff --git a/website/static/api/interfaces/eventlistenermanager.html b/website/static/api/interfaces/EventListenerManager.html similarity index 100% rename from website/static/api/interfaces/eventlistenermanager.html rename to website/static/api/interfaces/EventListenerManager.html diff --git a/website/static/api/interfaces/extensions.html b/website/static/api/interfaces/Extensions.html similarity index 100% rename from website/static/api/interfaces/extensions.html rename to website/static/api/interfaces/Extensions.html diff --git a/website/static/api/interfaces/field.html b/website/static/api/interfaces/Field.html similarity index 100% rename from website/static/api/interfaces/field.html rename to website/static/api/interfaces/Field.html diff --git a/website/static/api/interfaces/fieldinstance.html b/website/static/api/interfaces/FieldInstance.html similarity index 100% rename from website/static/api/interfaces/fieldinstance.html rename to website/static/api/interfaces/FieldInstance.html diff --git a/website/static/api/interfaces/filter.html b/website/static/api/interfaces/Filter.html similarity index 100% rename from website/static/api/interfaces/filter.html rename to website/static/api/interfaces/Filter.html diff --git a/website/static/api/interfaces/filterchangedevent.html b/website/static/api/interfaces/FilterChangedEvent.html similarity index 100% rename from website/static/api/interfaces/filterchangedevent.html rename to website/static/api/interfaces/FilterChangedEvent.html diff --git a/website/static/api/interfaces/filteroptions.html b/website/static/api/interfaces/FilterOptions.html similarity index 100% rename from website/static/api/interfaces/filteroptions.html rename to website/static/api/interfaces/FilterOptions.html diff --git a/website/static/api/interfaces/formattingsheet.html b/website/static/api/interfaces/FormattingSheet.html similarity index 100% rename from website/static/api/interfaces/formattingsheet.html rename to website/static/api/interfaces/FormattingSheet.html diff --git a/website/static/api/interfaces/getsummarydataoptions.html b/website/static/api/interfaces/GetSummaryDataOptions.html similarity index 100% rename from website/static/api/interfaces/getsummarydataoptions.html rename to website/static/api/interfaces/GetSummaryDataOptions.html diff --git a/website/static/api/interfaces/getunderlyingdataoptions.html b/website/static/api/interfaces/GetUnderlyingDataOptions.html similarity index 100% rename from website/static/api/interfaces/getunderlyingdataoptions.html rename to website/static/api/interfaces/GetUnderlyingDataOptions.html diff --git a/website/static/api/interfaces/hierarchicalfilter.html b/website/static/api/interfaces/HierarchicalFilter.html similarity index 100% rename from website/static/api/interfaces/hierarchicalfilter.html rename to website/static/api/interfaces/HierarchicalFilter.html diff --git a/website/static/api/interfaces/hierarchicalfilterdatavalue.html b/website/static/api/interfaces/HierarchicalFilterDataValue.html similarity index 100% rename from website/static/api/interfaces/hierarchicalfilterdatavalue.html rename to website/static/api/interfaces/HierarchicalFilterDataValue.html diff --git a/website/static/api/interfaces/hierarchicalleveldetail.html b/website/static/api/interfaces/HierarchicalLevelDetail.html similarity index 100% rename from website/static/api/interfaces/hierarchicalleveldetail.html rename to website/static/api/interfaces/HierarchicalLevelDetail.html diff --git a/website/static/api/interfaces/hierarchicallevels.html b/website/static/api/interfaces/HierarchicalLevels.html similarity index 100% rename from website/static/api/interfaces/hierarchicallevels.html rename to website/static/api/interfaces/HierarchicalLevels.html diff --git a/website/static/api/interfaces/logicaltable.html b/website/static/api/interfaces/LogicalTable.html similarity index 100% rename from website/static/api/interfaces/logicaltable.html rename to website/static/api/interfaces/LogicalTable.html diff --git a/website/static/api/interfaces/markinfo.html b/website/static/api/interfaces/MarkInfo.html similarity index 100% rename from website/static/api/interfaces/markinfo.html rename to website/static/api/interfaces/MarkInfo.html diff --git a/website/static/api/interfaces/markscollection.html b/website/static/api/interfaces/MarksCollection.html similarity index 100% rename from website/static/api/interfaces/markscollection.html rename to website/static/api/interfaces/MarksCollection.html diff --git a/website/static/api/interfaces/marksselectedevent.html b/website/static/api/interfaces/MarksSelectedEvent.html similarity index 100% rename from website/static/api/interfaces/marksselectedevent.html rename to website/static/api/interfaces/MarksSelectedEvent.html diff --git a/website/static/api/interfaces/marksspecification.html b/website/static/api/interfaces/MarksSpecification.html similarity index 100% rename from website/static/api/interfaces/marksspecification.html rename to website/static/api/interfaces/MarksSpecification.html diff --git a/website/static/api/interfaces/parameter.html b/website/static/api/interfaces/Parameter.html similarity index 100% rename from website/static/api/interfaces/parameter.html rename to website/static/api/interfaces/Parameter.html diff --git a/website/static/api/interfaces/parameterchangedevent.html b/website/static/api/interfaces/ParameterChangedEvent.html similarity index 100% rename from website/static/api/interfaces/parameterchangedevent.html rename to website/static/api/interfaces/ParameterChangedEvent.html diff --git a/website/static/api/interfaces/parameterdomainrestriction.html b/website/static/api/interfaces/ParameterDomainRestriction.html similarity index 100% rename from website/static/api/interfaces/parameterdomainrestriction.html rename to website/static/api/interfaces/ParameterDomainRestriction.html diff --git a/website/static/api/interfaces/point.html b/website/static/api/interfaces/Point.html similarity index 100% rename from website/static/api/interfaces/point.html rename to website/static/api/interfaces/Point.html diff --git a/website/static/api/interfaces/rangedomain.html b/website/static/api/interfaces/RangeDomain.html similarity index 100% rename from website/static/api/interfaces/rangedomain.html rename to website/static/api/interfaces/RangeDomain.html diff --git a/website/static/api/interfaces/rangefilter.html b/website/static/api/interfaces/RangeFilter.html similarity index 100% rename from website/static/api/interfaces/rangefilter.html rename to website/static/api/interfaces/RangeFilter.html diff --git a/website/static/api/interfaces/rangefilteroptions.html b/website/static/api/interfaces/RangeFilterOptions.html similarity index 100% rename from website/static/api/interfaces/rangefilteroptions.html rename to website/static/api/interfaces/RangeFilterOptions.html diff --git a/website/static/api/interfaces/rangevalue.html b/website/static/api/interfaces/RangeValue.html similarity index 100% rename from website/static/api/interfaces/rangevalue.html rename to website/static/api/interfaces/RangeValue.html diff --git a/website/static/api/interfaces/relativedatefilter.html b/website/static/api/interfaces/RelativeDateFilter.html similarity index 100% rename from website/static/api/interfaces/relativedatefilter.html rename to website/static/api/interfaces/RelativeDateFilter.html diff --git a/website/static/api/interfaces/relativedatefilteroptions.html b/website/static/api/interfaces/RelativeDateFilterOptions.html similarity index 100% rename from website/static/api/interfaces/relativedatefilteroptions.html rename to website/static/api/interfaces/RelativeDateFilterOptions.html diff --git a/website/static/api/interfaces/selectioncriteria.html b/website/static/api/interfaces/SelectionCriteria.html similarity index 100% rename from website/static/api/interfaces/selectioncriteria.html rename to website/static/api/interfaces/SelectionCriteria.html diff --git a/website/static/api/interfaces/settings.html b/website/static/api/interfaces/Settings.html similarity index 100% rename from website/static/api/interfaces/settings.html rename to website/static/api/interfaces/Settings.html diff --git a/website/static/api/interfaces/settingschangedevent.html b/website/static/api/interfaces/SettingsChangedEvent.html similarity index 100% rename from website/static/api/interfaces/settingschangedevent.html rename to website/static/api/interfaces/SettingsChangedEvent.html diff --git a/website/static/api/interfaces/sheet.html b/website/static/api/interfaces/Sheet.html similarity index 100% rename from website/static/api/interfaces/sheet.html rename to website/static/api/interfaces/Sheet.html diff --git a/website/static/api/interfaces/size.html b/website/static/api/interfaces/Size.html similarity index 100% rename from website/static/api/interfaces/size.html rename to website/static/api/interfaces/Size.html diff --git a/website/static/api/interfaces/summarydatachangedevent.html b/website/static/api/interfaces/SummaryDataChangedEvent.html similarity index 100% rename from website/static/api/interfaces/summarydatachangedevent.html rename to website/static/api/interfaces/SummaryDataChangedEvent.html diff --git a/website/static/api/interfaces/tablesummary.html b/website/static/api/interfaces/TableSummary.html similarity index 100% rename from website/static/api/interfaces/tablesummary.html rename to website/static/api/interfaces/TableSummary.html diff --git a/website/static/api/interfaces/tableauerror.html b/website/static/api/interfaces/TableauError.html similarity index 100% rename from website/static/api/interfaces/tableauerror.html rename to website/static/api/interfaces/TableauError.html diff --git a/website/static/api/interfaces/tableauevent.html b/website/static/api/interfaces/TableauEvent.html similarity index 100% rename from website/static/api/interfaces/tableauevent.html rename to website/static/api/interfaces/TableauEvent.html diff --git a/website/static/api/interfaces/tableausheetevent.html b/website/static/api/interfaces/TableauSheetEvent.html similarity index 100% rename from website/static/api/interfaces/tableausheetevent.html rename to website/static/api/interfaces/TableauSheetEvent.html diff --git a/website/static/api/interfaces/tableauworksheetevent.html b/website/static/api/interfaces/TableauWorksheetEvent.html similarity index 100% rename from website/static/api/interfaces/tableauworksheetevent.html rename to website/static/api/interfaces/TableauWorksheetEvent.html diff --git a/website/static/api/interfaces/tooltipcontext.html b/website/static/api/interfaces/TooltipContext.html similarity index 100% rename from website/static/api/interfaces/tooltipcontext.html rename to website/static/api/interfaces/TooltipContext.html diff --git a/website/static/api/interfaces/ui.html b/website/static/api/interfaces/UI.html similarity index 100% rename from website/static/api/interfaces/ui.html rename to website/static/api/interfaces/UI.html diff --git a/website/static/api/interfaces/visualspecification.html b/website/static/api/interfaces/VisualSpecification.html similarity index 100% rename from website/static/api/interfaces/visualspecification.html rename to website/static/api/interfaces/VisualSpecification.html diff --git a/website/static/api/interfaces/workbook.html b/website/static/api/interfaces/Workbook.html similarity index 100% rename from website/static/api/interfaces/workbook.html rename to website/static/api/interfaces/Workbook.html diff --git a/website/static/api/interfaces/workbookformatting.html b/website/static/api/interfaces/WorkbookFormatting.html similarity index 100% rename from website/static/api/interfaces/workbookformatting.html rename to website/static/api/interfaces/WorkbookFormatting.html diff --git a/website/static/api/interfaces/workbookformattingchangedevent.html b/website/static/api/interfaces/WorkbookFormattingChangedEvent.html similarity index 100% rename from website/static/api/interfaces/workbookformattingchangedevent.html rename to website/static/api/interfaces/WorkbookFormattingChangedEvent.html diff --git a/website/static/api/interfaces/worksheet.html b/website/static/api/interfaces/Worksheet.html similarity index 100% rename from website/static/api/interfaces/worksheet.html rename to website/static/api/interfaces/Worksheet.html diff --git a/website/static/api/interfaces/worksheetcontent.html b/website/static/api/interfaces/WorksheetContent.html similarity index 100% rename from website/static/api/interfaces/worksheetcontent.html rename to website/static/api/interfaces/WorksheetContent.html diff --git a/website/static/api/interfaces/worksheetformattingchangedevent.html b/website/static/api/interfaces/WorksheetFormattingChangedEvent.html similarity index 100% rename from website/static/api/interfaces/worksheetformattingchangedevent.html rename to website/static/api/interfaces/WorksheetFormattingChangedEvent.html